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*mr_tot_foldueirn*,tg8u_td_dsaigtzuaei,_t_data_sliizbef,wsi_err*o*re_tror);

       Volume item functions

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

       int
       libfwsi_volume_get_utf8_name(libfwsi_item_t*volumeu,int8_tutf8_strings,ize_ttf8_string_sizel,ibfwsi_error_t*error);

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

       int
       libfwsi_volume_get_utf16_name(libfwsi_item_tvolumeu,int16_tutf16_strings,izeu_tf16_string_sizlei,bfwsi_error*_terror);

       int
       libfwsi_volume_get_identifier(libfwsi_item_tvolumeu,int8_tguid_data,size_tguid_data_size,libfwsi_error_t**error);

       int
       libfwsi_volume_get_shell_folder_identifier(libfwsi_item*_tolumuei,nt8*_tuid_datsai,zeg_tid_data_silzieb,fwsi_erro*r*_trror);

       File entry item functions

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

       int
       libfwsi_file_entry_get_modification_time(libfwsi_item_t*file_entryu,int32_tfat_date_timel,ibfwsi_error_t*error);

       int
       libfwsi_file_entry_get_file_attribute_flags(libfwsi_ite*mf_tle_enturiyn,t3*2f_tle_attribute_flalgisb,fwsi_error*_terror);

       int
       libfwsi_file_entry_get_utf8_name_size(libfwsi_item_t*file_entry,size_t*utf8_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_file_entry_get_utf8_name(libfwsi_item*_tile_entruyi,nt8*_ttf8_strinsgi,zeu_tf8_string_sizlei,bfwsi_error*_terror);

       int
       libfwsi_file_entry_get_utf16_name_size(libfwsi_item_t*file_entrys,ize_tutf16_string_sizel,ibfwsi_error_t*error);

       int
       libfwsi_file_entry_get_utf16_name(libfwsi_ite*mf_tle_enturiyn,t1*6u_tf16_strisnigz,eu_tf16_string_sizlei,bfwsi_error*_terror);

       Network location item functions

       int
       libfwsi_network_location_get_utf8_location_size(libfwsi_ite*mn_ttwork_locatisoi*nzu,et_t8_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf8_location(libfwsi_i*tneemt_tork_locautiin*otun8t,_t8_strsiiunztgef,_t_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf16_location_size(libfwsi_it*enme_twork_locatsii*ozunet,_t16_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf16_location(libfwsi_i*tneemt_tork_locautiin*otun1t,6f_t6_stsuritizfne1g_,t_string_siibzfew,si_err*o*re_tror);

       int
       libfwsi_network_location_get_utf8_description_size(libfwsi_it*enme_twork_locatsii*ozunet,_t8_string_sliizbef,wsi_er*r*oerr_tor);

       int
       libfwsi_network_location_get_utf8_description(libfwsi_i*tneemt_tork_locauti*inuottn8f,_t_stsuritizfne8g_,tstring_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf16_description_size(libfwsi_it*enme_twork_locats*iiuoztnef,_t6_string_siibzfew,si_er*r*oerr_tor);

       int
       libfwsi_network_location_get_utf16_description(libfwsi_inteetmw_trk_locuaitn*ituo1tn6f,_t6_stsuritizfne1g_,t_string_siibzfew,si_er*r*oerr_tor);

       int
       libfwsi_network_location_get_utf8_comments_size(libfwsi_ite*mn_ttwork_locatisoi*nzu,et_t8_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf8_comments(libfwsi_i*tneemt_tork_locautiin*otun8t,_t8_strsiiunztgef,_t_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf16_comments_size(libfwsi_it*enme_twork_locatsii*ozunet,_t16_string_sliizbef,wsi_err*o*re_tror);

       int
       libfwsi_network_location_get_utf16_comments(libfwsi_i*tneemt_tork_locautiin*otun1t,6f_t6_stsuritizfne1g_,t_string_siibzfew,si_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_block*_txtension_blocuki,nt3*2s_tgnatulrieb,fwsi_erro*r*_trror);

       int
       libfwsi_extension_block_get_data_size(libfwsi_extension_bloc*ke_ttension_blocski,ze*_tata_sizlei,bfwsi_error*_terror);

       File entry extension functions

       int
       libfwsi_file_entry_extension_get_creation_time(libfwsi_extension_b*lfoiclke_tentry_exteuni*snfitao3tn2_,_tatel_tbifmwes,i_e*rerrorro_tint
       libfwsi_file_entry_extension_get_access_time(libfwsi_extension_b*lfoiclke_tentry_exteuni*snfitao3tn2_,_tatel_tbifmwes,i_er*r*oerr_tor);

       int
       libfwsi_file_entry_extension_get_file_reference(libfwsi_extension_b*lfoiclke_tentry_exteu*nifsniitlo6en4_,_tefleirbefnwcsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf8_long_name_size(libfwsi_extension*_billoec_ke_ttry*_etxsfti8ez_ness_itroinnl,gi_sfiwzsei,_e*rerrorro_tint
       libfwsi_file_entry_extension_get_utf8_long_name(libfwsi_extension_bfliolcek__tntry_ex*tuueitnnfust8ti8_fo_i8nttz_,resi_ntrgi,nlgi_sfiwzsei*,_eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf16_long_name_size(libfwsi_extension*_billoec_ke_ttry*_etxsfti1ez6ne_s_ittornil,nigb_swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf16_long_name(libfwsi_extension_bfliolcek__tntry_ex*tuueitunnftst1fi16s1o6_6n_z_,ttesr_itrnilgni,gb_swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf8_localized_name_size(libfwsi_extensio*nf_blleo_cekn_*truyt_es8xi_tzseetn_stiliniogbn_,swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf8_localized_name(libfwsi_extension_bfliolcek__tntry_euuxutttiffen8s8nt__s8szsi_etotr_nitil,nniggb,_swiszi*e_,eerrrroorr_tint
       libfwsi_file_entry_extension_get_utf16_localized_name_size(libfwsi_extensio*nf_blleo_cekn_*truyt_es1xi6tz_eesn_strliiionbngf,_ss*ii*z_eer,rrroorr_t

       int
       libfwsi_file_entry_extension_get_utf16_localized_name(libfwsi_extension*_billoec_ke_ttry_e*xuuutittenffnt11s16s6i6__o_zsnttet,r_litiinnbggf,_ss*ii*z_eer,rrroorr_t

       Shell folder identifier functions

       const 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-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.

SEE ALSO

       the libfwsi.h include file

libfwsi                                           April 8, 2018                                       libfwsi(3)