libfshfs.h — Library to access the Hierarchical File System (HFS) format

Author

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

Bugs

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

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.

Description

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

Environment

       None

Files

       None

Name

       libfshfs.h — Library to access the Hierarchical File System (HFS) format

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 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 "libfshfs.h".

Synopsis

#include<libfshfs.h>

       Support functions

       constchar*libfshfs_get_version(void);

       intlibfshfs_get_access_flags_read(void);

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

       intlibfshfs_set_codepage(intcodepage, libfshfs_error_t**error);

       intlibfshfs_check_volume_signature(constchar*filename, libfshfs_error_t**error);

       Available when compiled with wide character string support:

       intlibfshfs_check_volume_signature_wide(constwchar_t*filename, libfshfs_error_t**error);

       Available when compiled with libbfio support:

       intlibfshfs_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,
           libfshfs_error_t**error);

       Notify functions

       voidlibfshfs_notify_set_verbose(intverbose);

       intlibfshfs_notify_set_stream(FILE*stream, libfshfs_error_t**error);

       intlibfshfs_notify_stream_open(constchar*filename, libfshfs_error_t**error);

       intlibfshfs_notify_stream_close(libfshfs_error_t**error);

       Error functions

       voidlibfshfs_error_free(libfshfs_error_t**error);

       intlibfshfs_error_fprint(libfshfs_error_t*error, FILE*stream);

       intlibfshfs_error_sprint(libfshfs_error_t*error, char*string, size_tsize);

       intlibfshfs_error_backtrace_fprint(libfshfs_error_t*error, FILE*stream);

       intlibfshfs_error_backtrace_sprint(libfshfs_error_t*error, char*string, size_tsize);

       Volume functions

       intlibfshfs_volume_initialize(libfshfs_volume_t**volume, libfshfs_error_t**error);

       intlibfshfs_volume_free(libfshfs_volume_t**volume, libfshfs_error_t**error);

       intlibfshfs_volume_signal_abort(libfshfs_volume_t*volume, libfshfs_error_t**error);

       intlibfshfs_volume_open(libfshfs_volume_t*volume,    constchar*filename,    intaccess_flags,
           libfshfs_error_t**error);

       intlibfshfs_volume_close(libfshfs_volume_t*volume, libfshfs_error_t**error);

       intlibfshfs_volume_get_utf8_name_size(libfshfs_volume_t*volume,       size_t*utf8_string_size,
           libfshfs_error_t**error);

       intlibfshfs_volume_get_utf8_name(libfshfs_volume_t*volume, uint8_t*utf8_string,  size_tutf8_string_size,
           libfshfs_error_t**error);

       intlibfshfs_volume_get_utf16_name_size(libfshfs_volume_t*volume,      size_t*utf16_string_size,
           libfshfs_error_t**error);

       intlibfshfs_volume_get_utf16_name(libfshfs_volume_t*volume,         uint16_t*utf16_string,
           size_tutf16_string_size, libfshfs_error_t**error);

       intlibfshfs_volume_get_root_directory(libfshfs_volume_t*volume,    libfshfs_file_entry_t**file_entry,
           libfshfs_error_t**error);

       intlibfshfs_volume_get_file_entry_by_identifier(libfshfs_volume_t*volume,     uint32_tidentifier,
           libfshfs_file_entry_t**file_entry, libfshfs_error_t**error);

       intlibfshfs_volume_get_file_entry_by_utf8_path(libfshfs_volume_t*volume,   constuint8_t*utf8_string,
           size_tutf8_string_length, libfshfs_file_entry_t**file_entry, libfshfs_error_t**error);

       intlibfshfs_volume_get_file_entry_by_utf16_path(libfshfs_volume_t*volume,  constuint16_t*utf16_string,
           size_tutf16_string_length, libfshfs_file_entry_t**file_entry, libfshfs_error_t**error);

       Available when compiled with wide character string support:

       intlibfshfs_volume_open_wide(libfshfs_volume_t*volume,   constwchar_t*filename,  intaccess_flags,
           libfshfs_error_t**error);

       Available when compiled with libbfio support:

       intlibfshfs_volume_open_file_io_handle(libfshfs_volume_t*volume,    libbfio_handle_t*file_io_handle,
           intaccess_flags, libfshfs_error_t**error);

       File entry functions

       intlibfshfs_file_entry_free(libfshfs_file_entry_t**file_entry, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_identifier(libfshfs_file_entry_t*file_entry,      uint32_t*identifier,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_parent_identifier(libfshfs_file_entry_t*file_entry, uint32_t*parent_identifier,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_parent_file_entry(libfshfs_file_entry_t*file_entry,
           libfshfs_file_entry_t**parent_file_entry, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_link_identifier(libfshfs_file_entry_t*file_entry,  uint32_t*link_identifier,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_creation_time(libfshfs_file_entry_t*file_entry,     uint32_t*hfs_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_modification_time(libfshfs_file_entry_t*file_entry,    uint32_t*hfs_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_entry_modification_time(libfshfs_file_entry_t*file_entry,  uint32_t*hfs_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_access_time(libfshfs_file_entry_t*file_entry,      uint32_t*hfs_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_backup_time(libfshfs_file_entry_t*file_entry,      uint32_t*hfs_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_added_time(libfshfs_file_entry_t*file_entry,      int32_t*posix_time,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_file_mode(libfshfs_file_entry_t*file_entry,      uint16_t*file_mode,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_number_of_links(libfshfs_file_entry_t*file_entry,  uint32_t*number_of_links,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_owner_identifier(libfshfs_file_entry_t*file_entry,  uint32_t*owner_identifier,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_group_identifier(libfshfs_file_entry_t*file_entry,  uint32_t*group_identifier,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_device_identifier(libfshfs_file_entry_t*file_entry, uint32_t*device_identifier,
           libfshfs_error_t**error);

       intlibfshfs_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);

       intlibfshfs_file_entry_get_utf8_name_size(libfshfs_file_entry_t*file_entry,   size_t*utf8_string_size,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf8_name(libfshfs_file_entry_t*file_entry,      uint8_t*utf8_string,
           size_tutf8_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf16_name_size(libfshfs_file_entry_t*file_entry,  size_t*utf16_string_size,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf16_name(libfshfs_file_entry_t*file_entry,     uint16_t*utf16_string,
           size_tutf16_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf8_symbolic_link_target_size(libfshfs_file_entry_t*file_entry,
           size_t*utf8_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf8_symbolic_link_target(libfshfs_file_entry_t*file_entry,
           uint8_t*utf8_string, size_tutf8_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf16_symbolic_link_target_size(libfshfs_file_entry_t*file_entry,
           size_t*utf16_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_utf16_symbolic_link_target(libfshfs_file_entry_t*file_entry,
           uint16_t*utf16_string, size_tutf16_string_size, libfshfs_error_t**error);

       intlibfshfs_file_entry_has_resource_fork(libfshfs_file_entry_t*file_entry, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_resource_fork(libfshfs_file_entry_t*file_entry,
           libfshfs_data_stream_t**data_stream, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_number_of_extended_attributes(libfshfs_file_entry_t*file_entry,
           int*number_of_extended_attributes, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_extended_attribute_by_index(libfshfs_file_entry_t*file_entry,
           intextended_attribute_index,        libfshfs_extended_attribute_t**extended_attribute,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_has_extended_attribute_by_utf8_name(libfshfs_file_entry_t*file_entry,
           constuint8_t*utf8_string, size_tutf8_string_length, libfshfs_error_t**error);

       intlibfshfs_file_entry_has_extended_attribute_by_utf16_name(libfshfs_file_entry_t*file_entry,
           constuint16_t*utf16_string, size_tutf16_string_length, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_extended_attribute_by_utf8_name(libfshfs_file_entry_t*file_entry,
           constuint8_t*utf8_string,             size_tutf8_string_length,
           libfshfs_extended_attribute_t**extended_attribute, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_extended_attribute_by_utf16_name(libfshfs_file_entry_t*file_entry,
           constuint16_t*utf16_string,            size_tutf16_string_length,
           libfshfs_extended_attribute_t**extended_attribute, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_number_of_sub_file_entries(libfshfs_file_entry_t*file_entry,
           int*number_of_sub_file_entries, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_sub_file_entry_by_index(libfshfs_file_entry_t*file_entry,
           intsub_file_entry_index, libfshfs_file_entry_t**sub_file_entry, libfshfs_error_t**error);

       intlibfshfs_file_entry_get_sub_file_entry_by_utf8_name(libfshfs_file_entry_t*file_entry,
           constuint8_t*utf8_string,  size_tutf8_string_length,  libfshfs_file_entry_t**sub_file_entry,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_sub_file_entry_by_utf16_name(libfshfs_file_entry_t*file_entry,
           constuint16_t*utf16_string,  size_tutf16_string_length,  libfshfs_file_entry_t**sub_file_entry,
           libfshfs_error_t**error);

       ssize_tlibfshfs_file_entry_read_buffer(libfshfs_file_entry_t*file_entry,  void*buffer,  size_tbuffer_size,
           libfshfs_error_t**error);

       ssize_tlibfshfs_file_entry_read_buffer_at_offset(libfshfs_file_entry_t*file_entry,      void*buffer,
           size_tbuffer_size, off64_toffset, libfshfs_error_t**error);

       off64_tlibfshfs_file_entry_seek_offset(libfshfs_file_entry_t*file_entry,   off64_toffset,   intwhence,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_offset(libfshfs_file_entry_t*file_entry,         off64_t*offset,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_size(libfshfs_file_entry_t*file_entry,          size64_t*size,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_number_of_extents(libfshfs_file_entry_t*file_entry,   int*number_of_extents,
           libfshfs_error_t**error);

       intlibfshfs_file_entry_get_extent_by_index(libfshfs_file_entry_t*file_entry,     intextent_index,
           off64_t*extent_offset, size64_t*extent_size, uint32_t*extent_flags, libfshfs_error_t**error);

       Data stream functions

       intlibfshfs_data_stream_free(libfshfs_data_stream_t**data_stream, libfshfs_error_t**error);

       ssize_tlibfshfs_data_stream_read_buffer(libfshfs_data_stream_t*data_stream, void*buffer,  size_tbuffer_size,
           libfshfs_error_t**error);

       ssize_tlibfshfs_data_stream_read_buffer_at_offset(libfshfs_data_stream_t*data_stream,     void*buffer,
           size_tbuffer_size, off64_toffset, libfshfs_error_t**error);

       off64_tlibfshfs_data_stream_seek_offset(libfshfs_data_stream_t*data_stream,  off64_toffset,   intwhence,
           libfshfs_error_t**error);

       intlibfshfs_data_stream_get_offset(libfshfs_data_stream_t*data_stream,        off64_t*offset,
           libfshfs_error_t**error);

       intlibfshfs_data_stream_get_size(libfshfs_data_stream_t*data_stream,         size64_t*size,
           libfshfs_error_t**error);

       intlibfshfs_data_stream_get_number_of_extents(libfshfs_data_stream_t*data_stream,  int*number_of_extents,
           libfshfs_error_t**error);

       intlibfshfs_data_stream_get_extent_by_index(libfshfs_data_stream_t*data_stream,    intextent_index,
           off64_t*extent_offset, size64_t*extent_size, uint32_t*extent_flags, libfshfs_error_t**error);

       Extended attribute functions

       intlibfshfs_extended_attribute_free(libfshfs_extended_attribute_t**extended_attribute,
           libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_utf8_name_size(libfshfs_extended_attribute_t*extended_attribute,
           size_t*utf8_string_size, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_utf8_name(libfshfs_extended_attribute_t*extended_attribute,
           uint8_t*utf8_string, size_tutf8_string_size, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_utf16_name_size(libfshfs_extended_attribute_t*extended_attribute,
           size_t*utf16_string_size, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_utf16_name(libfshfs_extended_attribute_t*extended_attribute,
           uint16_t*utf16_string, size_tutf16_string_size, libfshfs_error_t**error);

       ssize_tlibfshfs_extended_attribute_read_buffer(libfshfs_extended_attribute_t*extended_attribute, void*buffer,
           size_tbuffer_size, libfshfs_error_t**error);

       ssize_tlibfshfs_extended_attribute_read_buffer_at_offset(libfshfs_extended_attribute_t*extended_attribute,
           void*buffer, size_tbuffer_size, off64_toffset, libfshfs_error_t**error);

       off64_tlibfshfs_extended_attribute_seek_offset(libfshfs_extended_attribute_t*extended_attribute,
           off64_toffset, intwhence, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_offset(libfshfs_extended_attribute_t*extended_attribute,
           off64_t*offset, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_size(libfshfs_extended_attribute_t*extended_attribute,  size64_t*size,
           libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_number_of_extents(libfshfs_extended_attribute_t*extended_attribute,
           int*number_of_extents, libfshfs_error_t**error);

       intlibfshfs_extended_attribute_get_extent_by_index(libfshfs_extended_attribute_t*extended_attribute,
           intextent_index,   off64_t*extent_offset,   size64_t*extent_size,   uint32_t*extent_flags,
           libfshfs_error_t**error);