libsmraw.h — Library to access the storage media (SM) (split) RAW format

Author

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

Bugs

       Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libsmraw/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 libsmraw_get_version() function is used to retrieve the library version.

Environment

       None

Files

       None

Name

       libsmraw.h — Library to access the storage media (SM) (split) RAW format

Notes

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

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

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

Synopsis

#include<libsmraw.h>

       Support functions

       constchar*libsmraw_get_version(void);

       intlibsmraw_get_access_flags_read(void);

       intlibsmraw_get_access_flags_read_write(void);

       intlibsmraw_get_access_flags_write(void);

       intlibsmraw_get_codepage(int*codepage, libsmraw_error_t**error);

       intlibsmraw_set_codepage(intcodepage, libsmraw_error_t**error);

       intlibsmraw_glob(constchar*filename, size_tfilename_length, char**filenames[], int*number_of_filenames,
           libsmraw_error_t**error);

       intlibsmraw_glob_free(char*filenames[], intnumber_of_filenames, libsmraw_error_t**error);

       intlibsmraw_glob_wide(constwchar_t*filename,    size_tfilename_length,   wchar_t**filenames[],
           int*number_of_filenames, libsmraw_error_t**error);

       intlibsmraw_glob_wide_free(wchar_t*filenames[], intnumber_of_filenames, libsmraw_error_t**error);

       Notify functions

       voidlibsmraw_notify_set_verbose(intverbose);

       intlibsmraw_notify_set_stream(FILE*stream, libsmraw_error_t**error);

       intlibsmraw_notify_stream_open(constchar*filename, libsmraw_error_t**error);

       intlibsmraw_notify_stream_close(libsmraw_error_t**error);

       Error functions

       voidlibsmraw_error_free(libsmraw_error_t**error);

       intlibsmraw_error_fprint(libsmraw_error_t*error, FILE*stream);

       intlibsmraw_error_sprint(libsmraw_error_t*error, char*string, size_tsize);

       intlibsmraw_error_backtrace_fprint(libsmraw_error_t*error, FILE*stream);

       intlibsmraw_error_backtrace_sprint(libsmraw_error_t*error, char*string, size_tsize);

       Handle functions

       intlibsmraw_handle_initialize(libsmraw_handle_t**handle, libsmraw_error_t**error);

       intlibsmraw_handle_free(libsmraw_handle_t**handle, libsmraw_error_t**error);

       intlibsmraw_handle_signal_abort(libsmraw_handle_t*handle, libsmraw_error_t**error);

       intlibsmraw_handle_open(libsmraw_handle_t*handle,  char*constfilenames[],  intnumber_of_filenames,
           intaccess_flags, libsmraw_error_t**error);

       intlibsmraw_handle_close(libsmraw_handle_t*handle, libsmraw_error_t**error);

       ssize_tlibsmraw_handle_read_buffer(libsmraw_handle_t*handle,     void*buffer,    size_tbuffer_size,
           libsmraw_error_t**error);

       ssize_tlibsmraw_handle_read_buffer_at_offset(libsmraw_handle_t*handle,  void*buffer,   size_tbuffer_size,
           off64_toffset, libsmraw_error_t**error);

       ssize_tlibsmraw_handle_write_buffer(libsmraw_handle_t*handle,   constvoid*buffer,  size_tbuffer_size,
           libsmraw_error_t**error);

       ssize_tlibsmraw_handle_write_buffer_at_offset(libsmraw_handle_t*handle, constvoid*buffer, size_tbuffer_size,
           off64_toffset, libsmraw_error_t**error);

       off64_tlibsmraw_handle_seek_offset(libsmraw_handle_t*handle,     off64_toffset,      intwhence,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_offset(libsmraw_handle_t*handle, off64_t*offset, libsmraw_error_t**error);

       intlibsmraw_handle_set_maximum_number_of_open_handles(libsmraw_handle_t*handle,
           intmaximum_number_of_open_handles, libsmraw_error_t**error);

       intlibsmraw_handle_get_segment_filename_size(libsmraw_handle_t*handle,      size_t*filename_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_segment_filename(libsmraw_handle_t*handle,  char*filename,  size_tfilename_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_segment_filename(libsmraw_handle_t*handle,      constchar*filename,
           size_tfilename_length, libsmraw_error_t**error);

       intlibsmraw_handle_get_maximum_segment_size(libsmraw_handle_t*handle,   size64_t*maximum_segment_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_maximum_segment_size(libsmraw_handle_t*handle,   size64_tmaximum_segment_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_filename_size(libsmraw_handle_t*handle,        size_t*filename_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_filename(libsmraw_handle_t*handle,   char*filename,    size_tfilename_size,
           libsmraw_error_t**error);

       Available when compiled with wide character string support:

       intlibsmraw_handle_open_wide(libsmraw_handle_t*handle,      wchar_t*constfilenames[],
           intnumber_of_filenames, intaccess_flags, libsmraw_error_t**error);

       intlibsmraw_handle_get_segment_filename_size_wide(libsmraw_handle_t*handle,    size_t*filename_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_segment_filename_wide(libsmraw_handle_t*handle,       wchar_t*filename,
           size_tfilename_size, libsmraw_error_t**error);

       intlibsmraw_handle_set_segment_filename_wide(libsmraw_handle_t*handle,    constwchar_t*filename,
           size_tfilename_length, libsmraw_error_t**error);

       intlibsmraw_handle_get_filename_size_wide(libsmraw_handle_t*handle,       size_t*filename_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_filename_wide(libsmraw_handle_t*handle,  wchar_t*filename,  size_tfilename_size,
           libsmraw_error_t**error);

       Available when compiled with libbfio support:

       intlibsmraw_handle_open_file_io_pool(libsmraw_handle_t*handle,      libbfio_pool_t*file_io_pool,
           intaccess_flags, libsmraw_error_t**error);

       intlibsmraw_handle_get_file_io_handle(libsmraw_handle_t*handle,    libbfio_handle_t**file_io_handle,
           libsmraw_error_t**error);

       Meta data functions

       intlibsmraw_handle_get_media_size(libsmraw_handle_t*handle,          size64_t*media_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_media_size(libsmraw_handle_t*handle, size64_tmedia_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_bytes_per_sector(libsmraw_handle_t*handle,      uint32_t*bytes_per_sector,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_bytes_per_sector(libsmraw_handle_t*handle,      uint32_tbytes_per_sector,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_media_type(libsmraw_handle_t*handle, uint8_t*media_type, libsmraw_error_t**error);

       intlibsmraw_handle_set_media_type(libsmraw_handle_t*handle, uint8_tmedia_type, libsmraw_error_t**error);

       intlibsmraw_handle_get_media_flags(libsmraw_handle_t*handle,         uint8_t*media_flags,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_media_flags(libsmraw_handle_t*handle,          uint8_tmedia_flags,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_number_of_information_values(libsmraw_handle_t*handle,
           int*number_of_information_values, libsmraw_error_t**error);

       intlibsmraw_handle_get_information_value_identifier_size(libsmraw_handle_t*handle,
           intinformation_value_index, size_t*identifier_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_information_value_identifier(libsmraw_handle_t*handle, intinformation_value_index,
           uint8_t*identifier, size_tidentifier_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_utf8_information_value_size(libsmraw_handle_t*handle,  constuint8_t*identifier,
           size_tidentifier_length, size_t*utf8_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_utf8_information_value(libsmraw_handle_t*handle,   constuint8_t*identifier,
           size_tidentifier_length, uint8_t*utf8_string, size_tutf8_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_set_utf8_information_value(libsmraw_handle_t*handle,   constuint8_t*identifier,
           size_tidentifier_length,    constuint8_t*utf8_string,     size_tutf8_string_length,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_utf16_information_value_size(libsmraw_handle_t*handle,  constuint8_t*identifier,
           size_tidentifier_length, size_t*utf16_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_utf16_information_value(libsmraw_handle_t*handle,   constuint8_t*identifier,
           size_tidentifier_length,      uint16_t*utf16_string,      size_tutf16_string_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_utf16_information_value(libsmraw_handle_t*handle,   constuint8_t*identifier,
           size_tidentifier_length,    constuint16_t*utf16_string,    size_tutf16_string_length,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_number_of_integrity_hash_values(libsmraw_handle_t*handle,
           int*number_of_integrity_hash_values, libsmraw_error_t**error);

       intlibsmraw_handle_get_integrity_hash_value_identifier_size(libsmraw_handle_t*handle,
           intintegrity_hash_value_index, size_t*identifier_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_integrity_hash_value_identifier(libsmraw_handle_t*handle,
           intintegrity_hash_value_index,      uint8_t*identifier,      size_tidentifier_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_utf8_integrity_hash_value_size(libsmraw_handle_t*handle, constuint8_t*identifier,
           size_tidentifier_length, size_t*utf8_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_utf8_integrity_hash_value(libsmraw_handle_t*handle,   constuint8_t*identifier,
           size_tidentifier_length, uint8_t*utf8_string, size_tutf8_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_set_utf8_integrity_hash_value(libsmraw_handle_t*handle,  constuint8_t*identifier,
           size_tidentifier_length,     constuint8_t*utf8_string,    size_tutf8_string_length,
           libsmraw_error_t**error);

       intlibsmraw_handle_get_utf16_integrity_hash_value_size(libsmraw_handle_t*handle, constuint8_t*identifier,
           size_tidentifier_length, size_t*utf16_string_size, libsmraw_error_t**error);

       intlibsmraw_handle_get_utf16_integrity_hash_value(libsmraw_handle_t*handle,  constuint8_t*identifier,
           size_tidentifier_length,      uint16_t*utf16_string,      size_tutf16_string_size,
           libsmraw_error_t**error);

       intlibsmraw_handle_set_utf16_integrity_hash_value(libsmraw_handle_t*handle,  constuint8_t*identifier,
           size_tidentifier_length,    constuint16_t*utf16_string,    size_tutf16_string_length,
           libsmraw_error_t**error);