NAME

       libfwsi.h — Library to access the Windows Shell Item format

LIBRARY

       library “libfwsi”

SYNOPSIS

       #include <libfwsi.h>

       Support functions

       const char *
       libfwsi_get_version(void);

       Error functions

       void
       libfwsi_error_free(libfwsi_error_t **error);

       int
       libfwsi_error_fprint(libfwsi_error_t *error, FILE *stream);

       int
       libfwsi_error_sprint(libfwsi_error_t *error, char *string, size_t size);

       int
       libfwsi_error_backtrace_fprint(libfwsi_error_t *error, FILE *stream);

       int
       libfwsi_error_backtrace_sprint(libfwsi_error_t *error, char *string, size_t size);

       Item list functions

       int
       libfwsi_item_list_initialize(libfwsi_item_list_t **item_list, libfwsi_error_t **error);

       int
       libfwsi_item_list_free(libfwsi_item_list_t **item_list, libfwsi_error_t **error);

       int
       libfwsi_item_list_copy_from_byte_stream(libfwsi_item_l*iistte_ut_i*lonbintyss8ttt_,t_stsribezyaetm_,t_streama_siciniztie_,codeplaigbef,wsi_err*o*re_tror);

       int
       libfwsi_item_list_get_data_size(libfwsi_item_list_t *item_list, size_t*data_size,libfwsi_error_t**error);

       int
       libfwsi_item_list_get_number_of_items(libfwsi_item_list_titem_listi,nt*number_of_items,libfwsi_error_t**error);

       int
       libfwsi_item_list_get_item(libfwsi_item_list_t*item_list,intitem_indexl,ibfwsi_item_t*iteml,ibfwsi_error_t*error);

       Item functions

       int
       libfwsi_item_initialize(libfwsi_item_t **item, libfwsi_error_t **error);

       int
       libfwsi_item_free(libfwsi_item_t **item, libfwsi_error_t **error);

       int
       libfwsi_item_copy_from_byte_stream(libfwsi_ite*mi_cteoumni,sntt*8b_tte_stresaimzb,ey_te_stream_saiisznceti,i_codepalgieb,fwsi_erro*r*_trror);

       int
       libfwsi_item_get_type(libfwsi_item_t *item, int *type, libfwsi_error_t **error);

       int
       libfwsi_item_get_class_type(libfwsi_item_t *item, uint8_t *class_type, libfwsi_error_t **error);

       int
       libfwsi_item_get_signature(libfwsi_item_t *item, uint32_t *signature, libfwsi_error_t **error);

       int
       libfwsi_item_get_data_size(libfwsi_item_t *item, size_t *data_size, libfwsi_error_t **error);

       int
       libfwsi_item_get_number_of_extension_blocks(libfwsi_item_titei*mnn,tumber_of_extension_blocklsi,bfwsi_error*_terror);

       int
       libfwsi_item_get_extension_block(libfwseix_i*ietinnettsmei_ot,n_block_ilnidbefxw,si_extension_bl*o*cekx_tension_blloicbkf,wsi_err*o*re_tror);

       Root folder (item) functions

       int
       libfwsi_root_folder_get_shell_folder_identifier(libfwsi_ite*mi_uteimn,t*8s_tell_folder_identifiseirzsl,eii_btef,wsi_err*o*re_tror);

       Volume (item) functions

       int
       libfwsi_volume_get_utf8_name_size(libfwsi_item_t*item,size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_volume_get_utf8_name(libfwsi_item_t*item,uint8_t*utf8_strings,ize_ttf8_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_volume_get_utf16_name_size(libfwsi_item_t*item,size_t*utf16_string_size,libfwsi_error_t **error);

       int
       libfwsi_volume_get_utf16_name(libfwsi_item_titemu,int16_tutf16_strings,ize_ttf16_string_sizel,ibfwsi_error*_terror);

       int
       libfwsi_volume_get_identifier(libfwsi_item_t*item,uint8_t*identifier,size_tsize,libfwsi_error_t **error);

       int
       libfwsi_volume_get_shell_folder_identifier(libfwsi_item*_tteumi,nt8*_thell_folder_identifiseirzs,eil_iteb,fwsi_erro*r*_trror);

       File entry (item) functions

       int
       libfwsi_file_entry_get_file_size(libfwsi_item_t *item, uint32_t *file_size, libfwsi_error_t **error);

       int
       libfwsi_file_entry_get_modification_time(libfwsi_item_titemu,int32_t*modification_time,libfwsi_error_t**error);

       int
       libfwsi_file_entry_get_file_attribute_flags(libfwsi_item_titemu,int32*_tile_attribute_flaglsi,bfwsi_error*_terror);

       int
       libfwsi_file_entry_get_utf8_name_size(libfwsi_item_t*item,size_t*utf8_string_size,libfwsi_error_t**error);

       int
       libfwsi_file_entry_get_utf8_name(libfwsi_item_titemu,int8_tutf8_strings,ize_ttf8_string_sizel,ibfwsi_error*_terror);

       int
       libfwsi_file_entry_get_utf16_name_size(libfwsi_item_t*item,size_t*utf16_string_size,libfwsi_error_t**error);

       int
       libfwsi_file_entry_get_utf16_name(libfwsi_item_titemu,int16*_ttf16_strinsgi,zeu_tf16_string_sizlei,bfwsi_error*_terror);

       Network location (item) functions

       int
       libfwsi_network_location_get_utf8_location_size(libfwsi_item*_ttems,ize_tutf8_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_network_location_get_utf8_location(libfwsi_item*_tteumi,nt8*_ttf8_strisnigzu,et_t8_string_silzieb,fwsi_erro*r*_trror);

       int
       libfwsi_network_location_get_utf16_location_size(libfwsi_item*_ttesmi,ze*_ttf16_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_network_location_get_utf16_location(libfwsi_ite*mi_uteimn,t1*6u_tf16_strisnigzu,et_t16_string_silzieb,fwsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf8_description_size(libfwsi_item*_ttesmi,ze*_ttf8_string_sizlei,bfwsi_error_t*error);

       int
       libfwsi_network_location_get_utf8_description(libfwsi_ite*mi_uteimn,t*8u_tf8_strisnigzu,et_t8_string_silzieb,fwsi_erro*r*_trror);

       int
       libfwsi_network_location_get_utf16_description_size(libfwsi_ite*mi_tesmi,ze*_ttf16_string_sizlei,bfwsi_error*_terror);

       int
       libfwsi_network_location_get_utf16_description(libfwsi_ite*mi_uteimn,t1*6u_tf16_strsiiunztgef,_t6_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf8_comments_size(libfwsi_item*_ttems,ize_tutf8_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_network_location_get_utf8_comments(libfwsi_item*_tteumi,nt8*_ttf8_strisnigzu,et_t8_string_silzieb,fwsi_erro*r*_trror);

       int
       libfwsi_network_location_get_utf16_comments_size(libfwsi_item*_ttesmi,ze*_ttf16_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_network_location_get_utf16_comments(libfwsi_ite*mi_uteimn,t1*6u_tf16_strisnigzu,et_t16_string_silzieb,fwsi_err*o*re_tror);

       Extension block functions

       int
       libfwsi_extension_block_free(libfwsi_extension_block_t **extension_block, libfwsi_error_t **error);

       int
       libfwsi_extension_block_get_signature(libfwsi_extension_bloc*ke_ttension_bloucikn,t3*2s_tgnaturlei,bfwsi_error*_terror);

       int
       libfwsi_extension_block_get_data_size(libfwsi_extension_block*_txtension_blocski,ze*_tata_sizlei,bfwsi_erro*r*_trror);

       File entry extension functions

       int
       libfwsi_file_entry_extension_get_creation_time(libfwsi_item_titemu,int32_tcreation_timel,ibfwsi_error_t**error);

       int
       libfwsi_file_entry_extension_get_access_time(libfwsi_item_t*item,uint32_t*access_time,libfwsi_error_t**error);

       int
       libfwsi_file_entry_extension_get_file_reference(libfwsi_item*_ttemu,int64_tfile_referencel,ibfwsi_error_t*error);

       int
       libfwsi_file_entry_extension_get_utf8_long_name_size(libfwsi_extension_b*leoxctke_tsio*nu_tbiflz8oe_c_ktt,rinlgi_sfiwzsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf8_long_name(libfwsi_extension_belxotcekn_tio*nuu_tbnflt8o8_c_stkttif,rz8ie_n_gtt,ringl_sbifzwes,i_e*r*reorrr_tr);

       int
       libfwsi_file_entry_extension_get_utf16_long_name_size(libfwsi_extension_belxotcekn_ti*ounst_fbz1le6o_ctskt,rinlgi_sfiwzsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf16_long_name(libfwsi_extension_belxotcekn_tionu*_ubntltfo11uc66tk_f,tsi1tz6re_i_nttgr,inlgi_sfiwzsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf8_localized_name_size(libfwsi_extension_belxotcekn_*tiuotnsf_8bz_leso_ctrkil,nigb_swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf8_localized_name(libfwsi_extension*_bxltoecnks_to*nuu_tbnfult8to8_fc_i8kttz_,resi_ntrgi,nlgi_sfiwzsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf16_localized_name_size(libfwsi_extension*_bxltoecn*ksu_ttosfni1_6be_l_ottcrkil,nigb_swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf16_localized_name(libfwsi_extension*_bxltoecnks_*touunitu_ftbt1fl16s1o6_6c_z_kttes,r_itrnignl,gi_sfiwzsei,_e*rerrorro_tconst char *
       libfwsi_shell_folder_identifier_get_name(const uint8_t *shell_folder_identifier);

DESCRIPTION

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

RETURN VALUES

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

ENVIRONMENT

       None

FILES

       None

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2010-2016, 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.

SEE ALSO

       the libfwsi.h include file

libfwsi                                           July 1, 2015                                        libfwsi(3)