libfsext.h — Library to support the Extended File System (ext) format

Author

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

Bugs

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

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.

Description

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

Environment

       None

Files

       None

Name

       libfsext.h — Library to support the Extended File System (ext) format

Notes

       libfsext can be compiled with wide character support (wchar_t).

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

       LIBFSEXT_WIDE_CHARACTER_TYPE
        in libfsext/features.h can be used to determine if libfsext 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 "libfsext.h".

Synopsis

#include<libfsext.h>

       Support functions

       constchar*libfsext_get_version(void);

       intlibfsext_get_access_flags_read(void);

       intlibfsext_get_codepage(int*codepage, libfsext_error_t**error);

       intlibfsext_set_codepage(intcodepage, libfsext_error_t**error);

       intlibfsext_check_volume_signature(constchar*filename, libfsext_error_t**error);

       Available when compiled with wide character string support:

       intlibfsext_check_volume_signature_wide(constwchar_t*filename, libfsext_error_t**error);

       Available when compiled with libbfio support:

       intlibfsext_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,
           libfsext_error_t**error);

       Notify functions

       voidlibfsext_notify_set_verbose(intverbose);

       intlibfsext_notify_set_stream(FILE*stream, libfsext_error_t**error);

       intlibfsext_notify_stream_open(constchar*filename, libfsext_error_t**error);

       intlibfsext_notify_stream_close(libfsext_error_t**error);

       Error functions

       voidlibfsext_error_free(libfsext_error_t**error);

       intlibfsext_error_fprint(libfsext_error_t*error, FILE*stream);

       intlibfsext_error_sprint(libfsext_error_t*error, char*string, size_tsize);

       intlibfsext_error_backtrace_fprint(libfsext_error_t*error, FILE*stream);

       intlibfsext_error_backtrace_sprint(libfsext_error_t*error, char*string, size_tsize);

       Volume functions

       intlibfsext_volume_initialize(libfsext_volume_t**volume, libfsext_error_t**error);

       intlibfsext_volume_free(libfsext_volume_t**volume, libfsext_error_t**error);

       intlibfsext_volume_signal_abort(libfsext_volume_t*volume, libfsext_error_t**error);

       intlibfsext_volume_open(libfsext_volume_t*volume,    constchar*filename,    intaccess_flags,
           libfsext_error_t**error);

       intlibfsext_volume_close(libfsext_volume_t*volume, libfsext_error_t**error);

       intlibfsext_volume_get_format_version(libfsext_volume_t*volume,       uint8_t*format_version,
           libfsext_error_t**error);

       intlibfsext_volume_get_features_flags(libfsext_volume_t*volume,   uint32_t*compatible_features_flags,
           uint32_t*incompatible_features_flags,      uint32_t*read_only_compatible_features_flags,
           libfsext_error_t**error);

       intlibfsext_volume_get_identifier(libfsext_volume_t*volume,  uint8_t*uuid_data,  size_tuuid_data_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf8_label_size(libfsext_volume_t*volume,       size_t*utf8_string_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf8_label(libfsext_volume_t*volume, uint8_t*utf8_string, size_tutf8_string_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf16_label_size(libfsext_volume_t*volume,      size_t*utf16_string_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf16_label(libfsext_volume_t*volume,         uint16_t*utf16_string,
           size_tutf16_string_size, libfsext_error_t**error);

       intlibfsext_volume_get_utf8_last_mount_path_size(libfsext_volume_t*volume,   size_t*utf8_string_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf8_last_mount_path(libfsext_volume_t*volume,      uint8_t*utf8_string,
           size_tutf8_string_size, libfsext_error_t**error);

       intlibfsext_volume_get_utf16_last_mount_path_size(libfsext_volume_t*volume,   size_t*utf16_string_size,
           libfsext_error_t**error);

       intlibfsext_volume_get_utf16_last_mount_path(libfsext_volume_t*volume,     uint16_t*utf16_string,
           size_tutf16_string_size, libfsext_error_t**error);

       intlibfsext_volume_get_last_mount_time(libfsext_volume_t*volume,        int32_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_volume_get_last_written_time(libfsext_volume_t*volume,        int32_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_volume_get_root_directory(libfsext_volume_t*volume,    libfsext_file_entry_t**file_entry,
           libfsext_error_t**error);

       intlibfsext_volume_get_number_of_file_entries(libfsext_volume_t*volume,  uint32_t*number_of_file_entries,
           libfsext_error_t**error);

       intlibfsext_volume_get_file_entry_by_inode(libfsext_volume_t*volume,      uint32_tinode_number,
           libfsext_file_entry_t**file_entry, libfsext_error_t**error);

       intlibfsext_volume_get_file_entry_by_utf8_path(libfsext_volume_t*volume,   constuint8_t*utf8_string,
           size_tutf8_string_length, libfsext_file_entry_t**file_entry, libfsext_error_t**error);

       intlibfsext_volume_get_file_entry_by_utf16_path(libfsext_volume_t*volume,  constuint16_t*utf16_string,
           size_tutf16_string_length, libfsext_file_entry_t**file_entry, libfsext_error_t**error);

       Available when compiled with wide character string support:

       intlibfsext_volume_open_wide(libfsext_volume_t*volume,  constwchar_t*filename,   intaccess_flags,
           libfsext_error_t**error);

       Available when compiled with libbfio support:

       intlibfsext_volume_open_file_io_handle(libfsext_volume_t*volume,    libbfio_handle_t*file_io_handle,
           intaccess_flags, libfsext_error_t**error);

       File entry functions

       intlibfsext_file_entry_free(libfsext_file_entry_t**file_entry, libfsext_error_t**error);

       intlibfsext_file_entry_is_empty(libfsext_file_entry_t*file_entry, libfsext_error_t**error);

       intlibfsext_file_entry_get_inode_number(libfsext_file_entry_t*file_entry,    uint32_t*inode_number,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_access_time(libfsext_file_entry_t*file_entry,      int64_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_creation_time(libfsext_file_entry_t*file_entry,     int64_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_inode_change_time(libfsext_file_entry_t*file_entry,    int64_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_modification_time(libfsext_file_entry_t*file_entry,    int64_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_deletion_time(libfsext_file_entry_t*file_entry,     int32_t*posix_time,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_file_mode(libfsext_file_entry_t*file_entry,      uint16_t*file_mode,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_number_of_links(libfsext_file_entry_t*file_entry,  uint16_t*number_of_links,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_owner_identifier(libfsext_file_entry_t*file_entry,  uint32_t*owner_identifier,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_group_identifier(libfsext_file_entry_t*file_entry,  uint32_t*group_identifier,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_device_identifier(libfsext_file_entry_t*file_entry, uint32_t*device_identifier,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_device_number(libfsext_file_entry_t*file_entry,  uint8_t*major_device_number,
           uint8_t*minor_device_number, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf8_name_size(libfsext_file_entry_t*file_entry,   size_t*utf8_string_size,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_utf8_name(libfsext_file_entry_t*file_entry,      uint8_t*utf8_string,
           size_tutf8_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf16_name_size(libfsext_file_entry_t*file_entry,  size_t*utf16_string_size,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_utf16_name(libfsext_file_entry_t*file_entry,     uint16_t*utf16_string,
           size_tutf16_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf8_symbolic_link_target_size(libfsext_file_entry_t*file_entry,
           size_t*utf8_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf8_symbolic_link_target(libfsext_file_entry_t*file_entry,
           uint8_t*utf8_string, size_tutf8_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf16_symbolic_link_target_size(libfsext_file_entry_t*file_entry,
           size_t*utf16_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_utf16_symbolic_link_target(libfsext_file_entry_t*file_entry,
           uint16_t*utf16_string, size_tutf16_string_size, libfsext_error_t**error);

       intlibfsext_file_entry_get_number_of_extended_attributes(libfsext_file_entry_t*file_entry,
           int*number_of_extended_attributes, libfsext_error_t**error);

       intlibfsext_file_entry_get_extended_attribute_by_index(libfsext_file_entry_t*file_entry,
           intextended_attribute_index,        libfsext_extended_attribute_t**extended_attribute,
           libfsext_error_t**error);

       intlibfsext_file_entry_has_extended_attribute_by_utf8_name(libfsext_file_entry_t*file_entry,
           constuint8_t*utf8_string, size_tutf8_string_length, libfsext_error_t**error);

       intlibfsext_file_entry_has_extended_attribute_by_utf16_name(libfsext_file_entry_t*file_entry,
           constuint16_t*utf16_string, size_tutf16_string_length, libfsext_error_t**error);

       intlibfsext_file_entry_get_extended_attribute_by_utf8_name(libfsext_file_entry_t*file_entry,
           constuint8_t*utf8_string,             size_tutf8_string_length,
           libfsext_extended_attribute_t**extended_attribute, libfsext_error_t**error);

       intlibfsext_file_entry_get_extended_attribute_by_utf16_name(libfsext_file_entry_t*file_entry,
           constuint16_t*utf16_string,            size_tutf16_string_length,
           libfsext_extended_attribute_t**extended_attribute, libfsext_error_t**error);

       intlibfsext_file_entry_get_number_of_sub_file_entries(libfsext_file_entry_t*file_entry,
           int*number_of_sub_entries, libfsext_error_t**error);

       intlibfsext_file_entry_get_sub_file_entry_by_index(libfsext_file_entry_t*file_entry,
           intsub_file_entry_index, libfsext_file_entry_t**sub_file_entry, libfsext_error_t**error);

       intlibfsext_file_entry_get_sub_file_entry_by_utf8_name(libfsext_file_entry_t*file_entry,
           constuint8_t*utf8_string,  size_tutf8_string_length,  libfsext_file_entry_t**sub_file_entry,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_sub_file_entry_by_utf16_name(libfsext_file_entry_t*file_entry,
           constuint16_t*utf16_string,  size_tutf16_string_length, libfsext_file_entry_t**sub_file_entry,
           libfsext_error_t**error);

       ssize_tlibfsext_file_entry_read_buffer(libfsext_file_entry_t*file_entry,  void*buffer,  size_tbuffer_size,
           libfsext_error_t**error);

       ssize_tlibfsext_file_entry_read_buffer_at_offset(libfsext_file_entry_t*file_entry,      void*buffer,
           size_tbuffer_size, off64_toffset, libfsext_error_t**error);

       off64_tlibfsext_file_entry_seek_offset(libfsext_file_entry_t*file_entry,   off64_toffset,   intwhence,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_offset(libfsext_file_entry_t*file_entry,         off64_t*offset,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_size(libfsext_file_entry_t*file_entry,          size64_t*size,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_number_of_extents(libfsext_file_entry_t*file_entry,   int*number_of_extents,
           libfsext_error_t**error);

       intlibfsext_file_entry_get_extent_by_index(libfsext_file_entry_t*file_entry,     intextent_index,
           off64_t*extent_offset, size64_t*extent_size, uint32_t*extent_flags, libfsext_error_t**error);

       Extended attribute functions

       intlibfsext_extended_attribute_free(libfsext_extended_attribute_t**extended_attribute,
           libfsext_error_t**error);

       intlibfsext_extended_attribute_get_utf8_name_size(libfsext_extended_attribute_t*extended_attribute,
           size_t*utf8_string_size, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_utf8_name(libfsext_extended_attribute_t*extended_attribute,
           uint8_t*utf8_string, size_tutf8_string_size, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_utf16_name_size(libfsext_extended_attribute_t*extended_attribute,
           size_t*utf16_string_size, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_utf16_name(libfsext_extended_attribute_t*extended_attribute,
           uint16_t*utf16_string, size_tutf16_string_size, libfsext_error_t**error);

       ssize_tlibfsext_extended_attribute_read_buffer(libfsext_extended_attribute_t*extended_attribute, void*buffer,
           size_tbuffer_size, libfsext_error_t**error);

       ssize_tlibfsext_extended_attribute_read_buffer_at_offset(libfsext_extended_attribute_t*extended_attribute,
           void*buffer, size_tbuffer_size, off64_toffset, libfsext_error_t**error);

       off64_tlibfsext_extended_attribute_seek_offset(libfsext_extended_attribute_t*extended_attribute,
           off64_toffset, intwhence, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_offset(libfsext_extended_attribute_t*extended_attribute,
           off64_t*offset, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_size(libfsext_extended_attribute_t*extended_attribute,  size64_t*size,
           libfsext_error_t**error);

       intlibfsext_extended_attribute_get_number_of_extents(libfsext_extended_attribute_t*extended_attribute,
           int*number_of_extents, libfsext_error_t**error);

       intlibfsext_extended_attribute_get_extent_by_index(libfsext_extended_attribute_t*extended_attribute,
           intextent_index,   off64_t*extent_offset,   size64_t*extent_size,   uint32_t*extent_flags,
           libfsext_error_t**error);