Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
libfwsi(3)		    Library Functions Manual		    libfwsi(3)

NAME
       libfwsi.h -- Library to access the Windows Shell	Item format

SYNOPSIS
       #include	<libfwsi.h>

       Support functions

       const char *
       libfwsi_get_version(void);

       Notify functions

       void
       libfwsi_notify_set_verbose(int verbose);

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

       int
       libfwsi_notify_stream_open(const		    char	    *filename,
	   libfwsi_error_t **error);

       int
       libfwsi_notify_stream_close(libfwsi_error_t **error);

       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_list_t *item_list,
	   const    uint8_t	*byte_stream,	  size_t     byte_stream_size,
	   int ascii_codepage, libfwsi_error_t **error);

       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_t   *item_list,
	   int *number_of_items, libfwsi_error_t **error);

       int
       libfwsi_item_list_get_item(libfwsi_item_list_t		   *item_list,
	   int item_index, libfwsi_item_t **item, libfwsi_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_item_t		*item,
	   const    uint8_t	*byte_stream,	  size_t     byte_stream_size,
	   int ascii_codepage, libfwsi_error_t **error);

       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_delegate_folder_identifier(libfwsi_item_t	*item,
	   uint8_t	   *guid_data,	       size_t	       guid_data_size,
	   libfwsi_error_t **error);

       int
       libfwsi_item_get_number_of_extension_blocks(libfwsi_item_t	*item,
	   int *number_of_extension_blocks, libfwsi_error_t **error);

       int
       libfwsi_item_get_extension_block(libfwsi_item_t			*item,
	   int						extension_block_index,
	   libfwsi_extension_block_t			    **extension_block,
	   libfwsi_error_t **error);

       Root folder item	functions

       int
       libfwsi_root_folder_get_shell_folder_identifier(libfwsi_ite*mr_otot_folder,
	   uint8_t	   *guid_data,	       size_t	       guid_data_size,
	   libfwsi_error_t **error);

       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		      *volume,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_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_t		      *volume,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_volume_get_identifier(libfwsi_item_t		      *volume,
	   uint8_t	   *guid_data,	       size_t	       guid_data_size,
	   libfwsi_error_t **error);

       int
       libfwsi_volume_get_shell_folder_identifier(libfwsi_item_t      *volume,
	   uint8_t	   *guid_data,	       size_t	       guid_data_size,
	   libfwsi_error_t **error);

       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_entry,
	   uint32_t *fat_date_time, libfwsi_error_t **error);

       int
       libfwsi_file_entry_get_file_attribute_flags(libfwsi_item_t *file_entry,
	   uint32_t *file_attribute_flags, libfwsi_error_t **error);

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

       int
       libfwsi_file_entry_get_utf8_name(libfwsi_item_t		  *file_entry,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

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

       int
       libfwsi_file_entry_get_utf16_name(libfwsi_item_t		  *file_entry,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       Network location	item functions

       int
       libfwsi_network_location_get_utf8_location_size(libfws*in_eittweomr_kt_location,
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf8_location(libfwsi_ite*mn_ettwork_location,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_location_size(libfw*snie_tiwtoermk__tlocation,
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_location(libfwsi_it*enme_ttwork_location,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf8_description_size(lib*fnwestiw_oirtke_ml_otcation,
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf8_description(libfwsi_*inteetmw_otrk_location,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_description_size(li*bnfewtswio_rikt_elmo_ctation,
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_description(libfwsi*_niettewmo_rtk_location,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf8_comments_size(libfws*in_eittweomr_kt_location,
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf8_comments(libfwsi_ite*mn_ettwork_location,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_comments_size(libfw*snie_tiwtoermk__tlocation,
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_network_location_get_utf16_comments(libfwsi_it*enme_ttwork_location,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       Compressed folder functions

       int
       libfwsi_compressed_folder_get_utf8_name_size(libfwsi_*ictoemmp_rtessed_folder,
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_compressed_folder_get_utf8_name(libfwsi_item_*tcompressed_folder,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_compressed_folder_get_utf16_name_size(libfwsi*_ciotmepmr_etssed_folder,
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_compressed_folder_get_utf16_name(libfwsi_item*_ctompressed_folder,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       Control panel category functions

       int
       libfwsi_control_panel_category_get_identifier(li*bcfownstir_oilt_epma_ntel_category,
	   uint32_t *identifier, libfwsi_error_t **error);

       Control panel item functions

       int
       libfwsi_control_panel_item_get_identifier(libfwsi_it*ecmo_nttrol_panel_item,
	   uint8_t	    *guid_data,		size_t	       guid_data_size,
	   libfwsi_error_t **error);

       Users property view functions

       int
       libfwsi_users_property_view_get_known_folder_identi*usersl_ipbrfowpseir_tiyt_evmi_etw,
	   uint8_t	    *guid_data,		size_t	       guid_data_size,
	   libfwsi_error_t **error);

       int
       libfwsi_users_property_view_get_property_store_data*_ussers_lpirbofpwesrit_yi_tveime_wt,
	   size_t *data_size, libfwsi_error_t **error);

       int
       libfwsi_users_property_view_copy_property_store_dat*usleirbsf_wpsrio_pietretmy__tview,
	   uint8_t *data, size_t data_size, libfwsi_error_t **error);

       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*_ebxltoecnks_iton_block,
	   uint32_t *signature,	libfwsi_error_t	**error);

       int
       libfwsi_extension_block_get_data_size(libfwsi_extension*_ebxltoecnks_iton_block,
	   size_t *data_size, libfwsi_error_t **error);

       File entry extension functions

       int
       libfwsi_file_entry_extension_get_creation_time(lib*ffwislie__eexntternys_ieoxnt_ebnlsoicokn_,t
	   uint32_t *fat_date_time, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_access_time(libfw*sfii_leex_teenntsriyo_ne_xbtleoncski_otn,
	   uint32_t *fat_date_time, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_file_reference(li*bffiwlsei__eenxttreyn_seixotne_nbslioocnk,_t
	   uint64_t *file_reference, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf8_long_name_si*fillei_befnwtsriy__eexxtteennssiioonn_,block_t
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf8_long_name(li*bffiwlsei__eenxttreyn_seixotne_nbslioocnk,_t
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf16_long_name_s*filel_iebnftwrsyi__eexxtteennssiioonn,_block_t
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf16_long_name(l*ifbiflwes_ie_netxrtye_nesxitoenn_sbiloonc,k_t
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf8_localized_na*fi_lse_zentlriyb_fewxstie_nesxitoenn,sion_block_t
	   size_t *utf8_string_size, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf8_localized_na*fillei_befnwtsriy__eexxtteennssiioonn_,block_t
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf16_localized_n*fil_es_ientrlyi_befxwtsein_seixotne,nsion_block_t
	   size_t *utf16_string_size, libfwsi_error_t **error);

       int
       libfwsi_file_entry_extension_get_utf16_localized_n*filel_iebnftwrsyi__eexxtteennssiioonn,_block_t
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfwsi_error_t **error);

       Shell folder identifier functions

       const char *
       libfwsi_shell_folder_identifier_get_name(counisntt*8s_htell_folder_identifier);

DESCRIPTION
       The libfwsi_get_version() function is used to retrieve the library ver-
       sion.

RETURN VALUES
       Most  of	the functions return NULL or -1	on error, dependent on the re-
       turn 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-2024,	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 17, 2024			    libfwsi(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=libfwsi&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help