logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

libolecf.h — Library to access the Object Linking and Embedding (OLE) Compound File (CF) format

Contents

Author

       These man pages are generated from "libolecf.h".

Bugs

       Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libolecf/issues

Description

       The libolecf_get_version() function is used to retrieve the library version.

Environment

       None

Files

       None

Library

       library “libolecf”

Name

       libolecf.h — Library to access the Object Linking and Embedding (OLE) Compound File (CF) format

Notes

       libolecf allows to be compiled with wide character support (wchar_t).

       To compile libolecf with wide character support use: ./configure--enable-wide-character-type=yes
        or define: _UNICODE
        or UNICODE
        during compilation.

       LIBOLECF_WIDE_CHARACTER_TYPE
        in libolecf/features.h can be used to determine if libolecf was compiled with wide character support.

Return Values

       Most  of  the  functions return NULL or -1 on error, dependent on the return type.  For the actual return
       values see "libolecf.h".

See Also

       the libolecf.h include file

libolecf                                        January 29, 2017                                     libolecf(3)

Synopsis

#include<libolecf.h>

       Support functions

       constchar*libolecf_get_version(void);

       uint8_tlibolecf_get_access_flags_read(void);

       intlibolecf_get_codepage(int*codepage,libolecf_error_t**error);

       intlibolecf_set_codepage(intcodepage,libolecf_error_t**error);

       intlibolecf_check_file_signature(constchar*filename,libolecf_error_t**error);

       Available when compiled with wide character string support:

       intlibolecf_check_file_signature_wide(constwchar_t*filename,libolecf_error_t**error);

       Available when compiled with libbfio support:

       intlibolecf_check_file_signature_file_io_handle(libbfio_handle_t*file_io_handle,libolecf_error_t**error);

       Notify functions

       voidlibolecf_notify_set_verbose(intverbose);

       intlibolecf_notify_set_stream(FILE*stream,libolecf_error_t**error);

       intlibolecf_notify_stream_open(constchar*filename,libolecf_error_t**error);

       intlibolecf_notify_stream_close(libolecf_error_t**error);

       Error functions

       voidlibolecf_error_free(libolecf_error_t**error);

       intlibolecf_error_fprint(libolecf_error_t*error,FILE*stream);

       intlibolecf_error_sprint(libolecf_error_t*error,char*string,size_tsize);

       intlibolecf_error_backtrace_fprint(libolecf_error_t*error,FILE*stream);

       intlibolecf_error_backtrace_sprint(libolecf_error_t*error,char*string,size_tsize);

       File functions

       intlibolecf_file_initialize(libolecf_file_t**file,libolecf_error_t**error);

       intlibolecf_file_free(libolecf_file_t**file,libolecf_error_t**error);

       intlibolecf_file_signal_abort(libolecf_file_t*file,libolecf_error_t**error);

       intlibolecf_file_open(libolecf_file_t*file,constchar*filename,intaccess_flags,libolecf_error_t**error);

       intlibolecf_file_close(libolecf_file_t*file,libolecf_error_t**error);

       intlibolecf_file_get_sector_size(libolecf_file_t*file,size32_t*sector_size,libolecf_error_t**error);

       intlibolecf_file_get_short_sector_size(libolecf_file_t*file,size32_t*short_sector_size,libolecf_error_t**error);

       intlibolecf_file_get_ascii_codepage(libolecf_file_t*file,int*ascii_codepage,libolecf_error_t**error);

       intlibolecf_file_set_ascii_codepage(libolecf_file_t*file,intascii_codepage,libolecf_error_t**error);

       intlibolecf_file_get_format_version(libolecf_file*_tiluei,nt16*_tajor_versiouni,nt16*_tinor_versiolni,bolecf_error_t*error);

       intlibolecf_file_get_number_of_unallocated_blocks(libolecf_fil*ef*_intlnuetm,ber_of_unallocated_bloclkisb,olecf_err*o*re_tror);

       intlibolecf_file_get_unallocated_block(libolecf_fil*efu_intlnaetl,located_block_indoefxf,6*4o_tfsseitz,e64*_tizlei,bolecf_error*_terror);

       intlibolecf_file_get_root_item(libolecf_file_t*file,libolecf_item_t**root_item,libolecf_error_t**error);

       intlibolecf_file_get_item_by_utf8_path(libolecf_fi*lfcueioi_nn*testu,t8t_t8_strsiiunztgef,_t_string_lenlgitbho,lecf_it*e*mil_itebmo,lecf_erro*r*_trror);

       intlibolecf_file_get_item_by_utf16_path(libolecf_fi*lfcueioi_nntest*,t1u6t_t16_strsiiunztgef,_t6_string_lenlgitbho,lecf_i*t*leiimtb_otml,ecf_er*r*oerr_tor);

       Available when compiled with wide character string support:

       intlibolecf_file_open_wide(libolecf_file_t*file,constwchar_t*filename,intaccess_flags,libolecf_error_t**error);

       Available when compiled with libbfio support:

       intlibolecf_file_open_file_io_handle(libolecf_file*_tillei,bbfio_handle*_tile_io_handliaenc,tcess_flalgisb,olecf_erro*r*_trror);

       Item functions

       intlibolecf_item_free(libolecf_item_t**item,libolecf_error_t**error);

       intlibolecf_item_get_type(libolecf_item_t*item,uint8_t*type,libolecf_error_t**error);

       intlibolecf_item_get_utf8_name_size(libolecf_item_t*item,size_t*utf8_string_size,libolecf_error_t**error);

       intlibolecf_item_get_utf8_name(libolecf_item_t*item,uint8_tutf8_strings,ize_ttf8_string_sizel,ibolecf_error_t*error);

       intlibolecf_item_get_utf16_name_size(libolecf_item_t*item,size_t*utf16_string_size,libolecf_error_t**error);

       intlibolecf_item_get_utf16_name(libolecf_item_titemu,int16_tutf16_strings,ize_ttf16_string_sizlei,bolecf_error*_terror);

       intlibolecf_item_get_size(libolecf_item_t*item,uint32_t*size,libolecf_error_t**error);

       intlibolecf_item_get_creation_time(libolecf_item_t*item,uint64_t*filetime,libolecf_error_t**error);

       intlibolecf_item_get_modification_time(libolecf_item_t*item,uint64_t*filetime,libolecf_error_t**error);

       intlibolecf_item_get_number_of_sub_items(libolecf_item_t*item,int*number_of_sub_items,libolecf_error_t**error);

       intlibolecf_item_get_sub_item(libolecf_item_t*item,instub_item_indexl,ibolecf_item_t*sub_iteml,ibolecf_error_t*error);

       intlibolecf_item_get_sub_item_by_utf8_name(libolecf_i*ci*tionuetnttmes8f_t_t,t_stsuritizfne8g_,tstring_lelnigbtohl,ecf_it*e*ms_tb_iltiebmo,lecf_err*o*re_tror);

       intlibolecf_item_get_sub_item_by_utf16_name(libolecf_i*cition*etntumes1t_t6ft,_t6_stsuritizfne1g_,t_string_lelnigbtohl,ecf_i*t*esmu_t_iitbeoml,ecf_e*r*reorrr_tr);

       intlibolecf_item_get_sub_item_by_utf8_path(libolecf_i*ci*tionuetnttmes8f_t_t,t_stsuritizfne8g_,tstring_lelnigbtohl,ecf_it*e*ms_tb_iltiebmo,lecf_err*o*re_tror);

       intlibolecf_item_get_sub_item_by_utf16_path(libolecf_i*cition*etntumes1t_t6ft,_t6_stsuritizfne1g_,t_string_lelnigbtohl,ecf_i*t*esmu_t_iitbeoml,ecf_e*r*reorrr_tr);

       Stream functions

       ssize_tlibolecf_stream_read_buffer(libolecf_item_t*stream,uint8_t*buffer,size_tsize,libolecf_error_t**error);

       off64_tlibolecf_stream_seek_offset(libolecf_item_t*stream,off64_toffset,intwhence,libolecf_error_t**error);

       intlibolecf_stream_get_offset(libolecf_item_t*stream,off64_t*offset,libolecf_error_t**error);

       Property set stream functions

       intlibolecf_property_set_stream_get_set(libolecf_iptreomp_trty_set_stlriebaoml,ecf_property_s*eptr_tpertyl_sbeotl,ecf_er*r*oerr_tor);

       Property set functions

       intlibolecf_property_set_free(libolecf_property_set_t**property_set,libolecf_error_t**error);

       intlibolecf_property_set_get_class_identifier(libolecf_property_s*eptr_tperty_sien*ttg,8u_td_gdiuaziteda_,tdata_siibzoel,ecf_er*r*oerr_tor);

       intlibolecf_property_set_get_number_of_sections(libolecf_property_s*eptr_tpert*yn_usnmetbte,r_of_sectiloinbso,lecf_err*o*re_tror);

       intlibolecf_property_set_get_section_by_index(libolecf_propesr*etpcyrt_ispoleeinitrn__tiotynl_esecexft,_,property_s*e*cptrioopne_tty_siebcotlieocnf*,_eerrrroorr_tint
       libolecf_property_section_free(libolecf_property_section_t**property_section,libolecf_error_t**error);

       intlibolecf_property_section_get_class_identifier(libolecf_property_se*cptrioopne_tty_su*eigcnuttigi8dsuo_intdzd,ae_t_ata,tal_sbiozlee,cf_e*r*reorrr_tr);

       intlibolecf_property_section_get_number_of_properties(libolecf_property_se*cptrioopne*_nttuym_sieenrct_toifo_np,ropleirbtoileesc,f*_eerrrroorr_tint
       libolecf_property_section_get_property_by_index(libolecf_propertpy*r_osrpeoecprltetiiryboti_nynil_netsdceefcx_t,piroonp,ert*y*_vraolpueerl_ityb_vlaelc*uf*e_,errrroorr_t

       Property value functions

       intlibolecf_property_value_free(libolecf_property_value_t**property_value,libolecf_error_t**error);

       intlibolecf_property_value_get_identifier(libolecf_property_valu*ep_toperty_valuuien,t3*2i_tentifileirb,olecf_erro*r*_trror);

       intlibolecf_property_value_get_value_type(libolecf_property_valu*ep_toperty_valuuien,t3*2v_tlue_tylpieb,olecf_erro*r*_trror);

       intlibolecf_property_value_get_data_size(libolecf_property_value*_troperty_valusei,ze*_tata_sizlei,bolecf_erro*r*_trror);

       intlibolecf_property_value_get_data(libolecf_property_valu*ep_toperty_valuuien,t8*_tatsai,zed_tta_sizlei,bolecf_error*_terror);

       intlibolecf_property_value_get_data_as_boolean(libolecf_property_val*uper_tperty_vauliun*etv,8a_tue_boolliebaonl,ecf_er*r*oerr_tor);

       intlibolecf_property_value_get_data_as_16bit_integer(libolecf_property_v*aplruoep_trty_vian*ltvu1ae6l,_te_1l6ibbiotl,ecf_er*r*oerr_tor);

       intlibolecf_property_value_get_data_as_32bit_integer(libolecf_property_va*lpureo_terty_vuailn*utve3a,2l_te_3i2bboilte,cf_e*r*reorrr_tr);

       intlibolecf_property_value_get_data_as_64bit_integer(libolecf_property_v*aplruoep_trty_vian*ltvu6ae4l,_te_6l4ibbiotl,ecf_er*r*oerr_tor);

       intlibolecf_property_value_get_data_as_filetime(libolecf_property_valu*ep_toperty_vauliunet*,6f4i_tetliimbeo,lecf_err*o*re_tror);

       intlibolecf_property_value_get_data_as_utf8_string_size(libolecf_property_vparloupee_*ttuyst_fvz8ae_l_utter,ingl_sbiozlee,cf_e*r*reorrr_tr);

       intlibolecf_property_value_get_data_as_utf8_string(libolecf_property_v*aplruoep_trty_*viuantltfu88ue_,tssfti8rz_iesn_gtr,inlgi_soilzeec,f_e*rerrorro_tint
       libolecf_property_value_get_data_as_utf16_string_size(libolecf_property_vparloupee_*ttuyst_fvz1ae6l_utset,rinlgi_soilzeec,f_e*rerrorro_tint
       libolecf_property_value_get_data_as_utf16_string(libolecf_property_vparloupee_ttyu*_uvntatfl11uu66te_f,tsi1tz6re_i_nttgr,inlgi_soilzeec,f_e*rerrorro_t
DESCRIPTION
       The libolecf_get_version() function is used to retrieve the library version.


RETURNVALUES
       Most  of  the  functions return NULL or -1 on error, dependent on the return type.  For the actual return
       values see "libolecf.h".


ENVIRONMENT
       None


FILES
       None


NOTES
       libolecf allows to be compiled with wide character support (wchar_t).

       To compile libolecf with wide character support use: ./configure--enable-wide-character-type=yes
        or define: _UNICODE
        or UNICODE
        during compilation.

       LIBOLECF_WIDE_CHARACTER_TYPE
        in libolecf/features.h can be used to determine if libolecf was compiled with wide character support.


BUGS
       Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libolecf/issues


AUTHOR
       These man pages are generated from "libolecf.h".


COPYRIGHT
       Copyright (C) 2008-2018, Joachim Metz <joachim.metz@gmail.com>.

       This is free software; see the source for copying  conditions.   There  is  NO  warranty;  not  even  for
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


SEEALSO
       the libolecf.h include file

libolecf                                        January 29, 2017                                     libolecf(3)

See Also

Error
Error PNG Icons
Filing
Filing PNG Icons
Man Pages
item_name, item_description Man Pages
Man Pages
property Man Pages
Value Research
Value Research PNG Icons
Man Pages
size Man Pages
String
String PNG Icons
← View Library functions Category← Back to String manipulation🙏  Credits & Acknowledgments