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

FreeBSD Manual Pages

  
 
  

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

NAME
       libfshfs.h -- Library to	access the Hierarchical	File System (HFS) for-
       mat

SYNOPSIS
       #include	<libfshfs.h>

       Support functions

       const char *
       libfshfs_get_version(void);

       int
       libfshfs_get_access_flags_read(void);

       int
       libfshfs_get_codepage(int *codepage, libfshfs_error_t **error);

       int
       libfshfs_set_codepage(int codepage, libfshfs_error_t **error);

       int
       libfshfs_check_volume_signature(const	      char	    *filename,
	   libfshfs_error_t **error);

       Available when compiled with wide character string support:

       int
       libfshfs_check_volume_signature_wide(const      wchar_t	    *filename,
	   libfshfs_error_t **error);

       Available when compiled with libbfio support:

       int
       libfshfs_check_volume_signature_file_io_handle(libbfio_h*afnidllee__ito_handle,
	   libfshfs_error_t **error);

       Notify functions

       void
       libfshfs_notify_set_verbose(int verbose);

       int
       libfshfs_notify_set_stream(FILE *stream,	libfshfs_error_t **error);

       int
       libfshfs_notify_stream_open(const	    char	    *filename,
	   libfshfs_error_t **error);

       int
       libfshfs_notify_stream_close(libfshfs_error_t **error);

       Error functions

       void
       libfshfs_error_free(libfshfs_error_t **error);

       int
       libfshfs_error_fprint(libfshfs_error_t *error, FILE *stream);

       int
       libfshfs_error_sprint(libfshfs_error_t	  *error,     char    *string,
	   size_t size);

       int
       libfshfs_error_backtrace_fprint(libfshfs_error_t	*error,	FILE *stream);

       int
       libfshfs_error_backtrace_sprint(libfshfs_error_t	*error,	char  *string,
	   size_t size);

       Volume functions

       int
       libfshfs_volume_initialize(libfshfs_volume_t		     **volume,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_free(libfshfs_volume_t			     **volume,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_signal_abort(libfshfs_volume_t		      *volume,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_open(libfshfs_volume_t *volume, const  char  *filename,
	   int access_flags, libfshfs_error_t **error);

       int
       libfshfs_volume_close(libfshfs_volume_t			      *volume,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_get_utf8_name_size(libfshfs_volume_t	      *volume,
	   size_t *utf8_string_size, libfshfs_error_t **error);

       int
       libfshfs_volume_get_utf8_name(libfshfs_volume_t		      *volume,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_get_utf16_name_size(libfshfs_volume_t	      *volume,
	   size_t *utf16_string_size, libfshfs_error_t **error);

       int
       libfshfs_volume_get_utf16_name(libfshfs_volume_t		      *volume,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_get_root_directory(libfshfs_volume_t	      *volume,
	   libfshfs_file_entry_t **file_entry, libfshfs_error_t	**error);

       int
       libfshfs_volume_get_file_entry_by_identifier(libfshfs_volume_t *volume,
	   uint32_t	identifier,	libfshfs_file_entry_t	 **file_entry,
	   libfshfs_error_t **error);

       int
       libfshfs_volume_get_file_entry_by_utf8_path(libfshfs_volume_t  *volume,
	   const     uint8_t	*utf8_string,	 size_t	   utf8_string_length,
	   libfshfs_file_entry_t **file_entry, libfshfs_error_t	**error);

       int
       libfshfs_volume_get_file_entry_by_utf16_path(libfshfs_volume_t *volume,
	   const   uint16_t   *utf16_string,	size_t	  utf16_string_length,
	   libfshfs_file_entry_t **file_entry, libfshfs_error_t	**error);

       Available when compiled with wide character string support:

       int
       libfshfs_volume_open_wide(libfshfs_volume_t		      *volume,
	   const       wchar_t	     *filename,	      int	 access_flags,
	   libfshfs_error_t **error);

       Available when compiled with libbfio support:

       int
       libfshfs_volume_open_file_io_handle(libfshfs_volume_t	      *volume,
	   libbfio_handle_t	 *file_io_handle,      int	 access_flags,
	   libfshfs_error_t **error);

       File entry functions

       int
       libfshfs_file_entry_free(libfshfs_file_entry_t		 **file_entry,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_identifier(libfshfs_file_entry_t	  *file_entry,
	   uint32_t *identifier, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_parent_identifier(libfshfs_file_entr*yf_itle_entry,
	   uint32_t *parent_identifier,	libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_parent_file_entry(libfshfs_file_entr*yf_itle_entry,
	   libfshfs_file_entry_t			  **parent_file_entry,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_link_identifier(libfshfs_file_entry_*tfile_entry,
	   uint32_t *link_identifier, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_creation_time(libfshfs_file_entry_t*file_entry,
	   uint32_t *hfs_time, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_modification_time(libfshfs_file_entr*yf_itle_entry,
	   uint32_t *hfs_time, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_entry_modification_time(libfshfs_fil*ef_ielnet_reyn_ttry,
	   uint32_t *hfs_time, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_access_time(libfshfs_file_entry_t  *file_entry,
	   uint32_t *hfs_time, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_backup_time(libfshfs_file_entry_t  *file_entry,
	   uint32_t *hfs_time, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_added_time(libfshfs_file_entry_t	  *file_entry,
	   int32_t *posix_time,	libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_file_mode(libfshfs_file_entry_t	  *file_entry,
	   uint16_t *file_mode,	libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_number_of_links(libfshfs_file_entry_*tfile_entry,
	   uint32_t *number_of_links, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_owner_identifier(libfshfs_file_entry*_ftile_entry,
	   uint32_t *owner_identifier, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_group_identifier(libfshfs_file_entry*_ftile_entry,
	   uint32_t *group_identifier, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_device_identifier(libfshfs_file_entr*yf_itle_entry,
	   uint32_t *device_identifier,	libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_device_number(libfshfs_file_entry_t*file_entry,
	   uint32_t   *major_device_number,   uint32_t	 *minor_device_number,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf8_name_size(libfshfs_file_entry_t*file_entry,
	   size_t *utf8_string_size, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf8_name(libfshfs_file_entry_t	  *file_entry,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf16_name_size(libfshfs_file_entry_*tfile_entry,
	   size_t *utf16_string_size, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf16_name(libfshfs_file_entry_t	  *file_entry,
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf8_symbolic_link_target_size(libfs*hffisl_ef_ielnet_reyn,try_t
	   size_t *utf8_string_size, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf8_symbolic_link_target(libfshfs_f*ifliel_ee_netnrtyr_yt,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf16_symbolic_link_target_size(libf*sfhiflse__feinlter_ye,ntry_t
	   size_t *utf16_string_size, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_utf16_symbolic_link_target(libfshfs_*ffiillee__eennttrryy_,t
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_has_resource_fork(libfshfs_file_entry_t*file_entry,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_resource_fork(libfshfs_file_entry_t*file_entry,
	   libfshfs_data_stream_t **data_stream, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_number_of_extended_attributes(libfsh*ffsi_lfei_leen_ternyt,ry_t
	   int *number_of_extended_attributes, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_extended_attribute_by_index(libfshfs*_ffiillee__eennttrryy,_t
	   int					     extended_attribute_index,
	   libfshfs_extended_attribute_t		 **extended_attribute,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_has_extended_attribute_by_utf8_name(libf*sfhiflse__feinlter_ye,ntry_t
	   const     uint8_t	*utf8_string,	 size_t	   utf8_string_length,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_has_extended_attribute_by_utf16_name(lib*ffsihlfes__efnitlrey_,entry_t
	   const    uint16_t	*utf16_string,	 size_t	  utf16_string_length,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_extended_attribute_by_utf8_name(libf*sfhiflse__feinlter_ye,ntry_t
	   const     uint8_t	*utf8_string,	 size_t	   utf8_string_length,
	   libfshfs_extended_attribute_t		 **extended_attribute,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_extended_attribute_by_utf16_name(lib*ffsihlfes__efnitlrey_,entry_t
	   const   uint16_t   *utf16_string,	size_t	  utf16_string_length,
	   libfshfs_extended_attribute_t		 **extended_attribute,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_number_of_sub_file_entries(libfshfs_*ffiillee__eennttrryy_,t
	   int *number_of_sub_file_entries, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_sub_file_entry_by_index(libfshfs_fil*ef_ielnet_reyn_ttry,
	   int sub_file_entry_index,  libfshfs_file_entry_t  **sub_file_entry,
	   libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_sub_file_entry_by_utf8_name(libfshfs*_ffiillee__eennttrryy,_t
	   const    uint8_t    *utf8_string,	size_t	   utf8_string_length,
	   libfshfs_file_entry_t **sub_file_entry, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_sub_file_entry_by_utf16_name(libfshf*sf_ifliel_ee_netnrtyr,y_t
	   const   uint16_t   *utf16_string,	size_t	  utf16_string_length,
	   libfshfs_file_entry_t **sub_file_entry, libfshfs_error_t **error);

       ssize_t
       libfshfs_file_entry_read_buffer(libfshfs_file_entry_t	  *file_entry,
	   void	*buffer, size_t	buffer_size, libfshfs_error_t **error);

       ssize_t
       libfshfs_file_entry_read_buffer_at_offset(libfshfs_file_entr*yf_itle_entry,
	   void	    *buffer,	 size_t	    buffer_size,    off64_t    offset,
	   libfshfs_error_t **error);

       off64_t
       libfshfs_file_entry_seek_offset(libfshfs_file_entry_t	  *file_entry,
	   off64_t offset, int whence, libfshfs_error_t	**error);

       int
       libfshfs_file_entry_get_offset(libfshfs_file_entry_t	  *file_entry,
	   off64_t *offset, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_size(libfshfs_file_entry_t	  *file_entry,
	   size64_t *size, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_number_of_extents(libfshfs_file_entr*yf_itle_entry,
	   int *number_of_extents, libfshfs_error_t **error);

       int
       libfshfs_file_entry_get_extent_by_index(libfshfs_file_entry_*tfile_entry,
	   int	extent_index,  off64_t	*extent_offset,	size64_t *extent_size,
	   uint32_t *extent_flags, libfshfs_error_t **error);

       Data stream functions

       int
       libfshfs_data_stream_free(libfshfs_data_stream_t		**data_stream,
	   libfshfs_error_t **error);

       ssize_t
       libfshfs_data_stream_read_buffer(libfshfs_data_stream_t	 *data_stream,
	   void	*buffer, size_t	buffer_size, libfshfs_error_t **error);

       ssize_t
       libfshfs_data_stream_read_buffer_at_offset(libfshfs_data_st*rdeaatma__tstream,
	   void	    *buffer,	 size_t	    buffer_size,    off64_t    offset,
	   libfshfs_error_t **error);

       off64_t
       libfshfs_data_stream_seek_offset(libfshfs_data_stream_t	 *data_stream,
	   off64_t offset, int whence, libfshfs_error_t	**error);

       int
       libfshfs_data_stream_get_offset(libfshfs_data_stream_t	 *data_stream,
	   off64_t *offset, libfshfs_error_t **error);

       int
       libfshfs_data_stream_get_size(libfshfs_data_stream_t	 *data_stream,
	   size64_t *size, libfshfs_error_t **error);

       int
       libfshfs_data_stream_get_number_of_extents(libfshfs_data_st*rdeaatma__tstream,
	   int *number_of_extents, libfshfs_error_t **error);

       int
       libfshfs_data_stream_get_extent_by_index(libfshfs_data_stre*adma_tta_stream,
	   int	extent_index,  off64_t	*extent_offset,	size64_t *extent_size,
	   uint32_t *extent_flags, libfshfs_error_t **error);

       Extended	attribute functions

       int
       libfshfs_extended_attribute_free(libfshfs_extended_*a*tetxrtiebnudteed__tattribute,
	   libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_utf8_name_size(libfs*hefxst_eenxdteedn_daetdt_raitbturtieb,ute_t
	   size_t *utf8_string_size, libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_utf8_name(libfshfs_e*xetxetnednedde_da_tattrtirbiubtuet_et,
	   uint8_t	  *utf8_string,	       size_t	     utf8_string_size,
	   libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_utf16_name_size(libf*sehxftse_nedxetde_nadtetdr_iabtuttrei,bute_t
	   size_t *utf16_string_size, libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_utf16_name(libfshfs_*eexxtteennddeedd__aattttrriibbuuttee_,t
	   uint16_t	  *utf16_string,       size_t	    utf16_string_size,
	   libfshfs_error_t **error);

       ssize_t
       libfshfs_extended_attribute_read_buffer(libfshfs_ext*eenxdteedn_daetdt_raitbturtieb_utte,
	   void	*buffer, size_t	buffer_size, libfshfs_error_t **error);

       ssize_t
       libfshfs_extended_attribute_read_buffer_at_offset(li*befxsthefnsd_eedx_taetntdreidb_uattet,ribute_t
	   void	    *buffer,	 size_t	    buffer_size,    off64_t    offset,
	   libfshfs_error_t **error);

       off64_t
       libfshfs_extended_attribute_seek_offset(libfshfs_ext*eenxdteedn_daetdt_raitbturtieb_utte,
	   off64_t offset, int whence, libfshfs_error_t	**error);

       int
       libfshfs_extended_attribute_get_offset(libfshfs_exte*nedxetde_nadtetdr_iabtuttrei_btute,
	   off64_t *offset, libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_size(libfshfs_extend*eedx_taetntdreidb_uattet_rtibute,
	   size64_t *size, libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_number_of_extents(li*befxsthefnsd_eedx_taetntdreidb_uattet,ribute_t
	   int *number_of_extents, libfshfs_error_t **error);

       int
       libfshfs_extended_attribute_get_extent_by_index(libf*sehxftse_nedxetde_nadtetdr_iabtuttrei,bute_t
	   int	extent_index,  off64_t	*extent_offset,	size64_t *extent_size,
	   uint32_t *extent_flags, libfshfs_error_t **error);

DESCRIPTION
       The libfshfs_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 re-
       turn type.  For the actual return values	see "libfshfs.h".

ENVIRONMENT
       None

FILES
       None

NOTES
       libfshfs	can be compiled	with wide character support (wchar_t).

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

       LIBFSHFS_WIDE_CHARACTER_TYPE
	in  libfshfs/features.h	 can be	used to	determine if libfshfs was com-
       piled with wide character support.

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

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

COPYRIGHT
       Copyright (C) 2009-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 libfshfs.h include file

libfshfs			August 31, 2022			   libfshfs(3)

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

home | help