libmodi.h — Library to access Mac OS disk image formats

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

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

       Copyright (C) 2012-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.

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

       None

       None

       libmodi.h — Library to access Mac OS disk image formats

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

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

       LIBMODI_WIDE_CHARACTER_TYPE
        in libmodi/features.h can be used to determine if libmodi was compiled with wide character support.

       Most  of  the  functions return NULL or -1 on error, dependent on the return type.  For the actual return
       values see "libmodi.h".

       the libmodi.h include file

libmodi                                         December 16, 2019                                     libmodi(3)

#include<libmodi.h>

       Support functions

       constchar*libmodi_get_version(void);

       intlibmodi_get_access_flags_read(void);

       intlibmodi_get_access_flags_read_write(void);

       intlibmodi_get_access_flags_write(void);

       intlibmodi_get_codepage(int*codepage, libmodi_error_t**error);

       intlibmodi_set_codepage(intcodepage, libmodi_error_t**error);

       intlibmodi_check_file_signature(constchar*filename, libmodi_error_t**error);

       Available when compiled with wide character string support:

       intlibmodi_check_file_signature_wide(constwchar_t*filename, libmodi_error_t**error);

       Available when compiled with libbfio support:

       intlibmodi_check_file_signature_file_io_handle(libbfio_handle_t*file_io_handle, libmodi_error_t**error);

       Notify functions

       voidlibmodi_notify_set_verbose(intverbose);

       intlibmodi_notify_set_stream(FILE*stream, libmodi_error_t**error);

       intlibmodi_notify_stream_open(constchar*filename, libmodi_error_t**error);

       intlibmodi_notify_stream_close(libmodi_error_t**error);

       Error functions

       voidlibmodi_error_free(libmodi_error_t**error);

       intlibmodi_error_fprint(libmodi_error_t*error, FILE*stream);

       intlibmodi_error_sprint(libmodi_error_t*error, char*string, size_tsize);

       intlibmodi_error_backtrace_fprint(libmodi_error_t*error, FILE*stream);

       intlibmodi_error_backtrace_sprint(libmodi_error_t*error, char*string, size_tsize);

       Handle functions

       intlibmodi_handle_initialize(libmodi_handle_t**handle, libmodi_error_t**error);

       intlibmodi_handle_free(libmodi_handle_t**handle, libmodi_error_t**error);

       intlibmodi_handle_signal_abort(libmodi_handle_t*handle, libmodi_error_t**error);

       intlibmodi_handle_open(libmodi_handle_t*handle,     constchar*filename,    intaccess_flags,
           libmodi_error_t**error);

       intlibmodi_handle_open_band_data_files(libmodi_handle_t*handle, libmodi_error_t**error);

       intlibmodi_handle_close(libmodi_handle_t*handle, libmodi_error_t**error);

       ssize_tlibmodi_handle_read_buffer(libmodi_handle_t*handle,     void*buffer,     size_tbuffer_size,
           libmodi_error_t**error);

       ssize_tlibmodi_handle_read_buffer_at_offset(libmodi_handle_t*handle,   void*buffer,   size_tbuffer_size,
           off64_toffset, libmodi_error_t**error);

       off64_tlibmodi_handle_seek_offset(libmodi_handle_t*handle,      off64_toffset,      intwhence,
           libmodi_error_t**error);

       intlibmodi_handle_get_offset(libmodi_handle_t*handle, off64_t*offset, libmodi_error_t**error);

       intlibmodi_handle_set_maximum_number_of_open_handles(libmodi_handle_t*handle,
           intmaximum_number_of_open_handles, libmodi_error_t**error);

       intlibmodi_handle_set_band_data_files_path(libmodi_handle_t*handle, constchar*path,  size_tpath_length,
           libmodi_error_t**error);

       intlibmodi_handle_get_media_size(libmodi_handle_t*handle, size64_t*media_size, libmodi_error_t**error);

       intlibmodi_handle_get_image_type(libmodi_handle_t*handle, int*image_type, libmodi_error_t**error);

       Available when compiled with wide character string support:

       intlibmodi_handle_open_wide(libmodi_handle_t*handle,   constwchar_t*filename,   intaccess_flags,
           libmodi_error_t**error);

       intlibmodi_handle_set_band_data_files_path_wide(libmodi_handle_t*handle,    constwchar_t*path,
           size_tpath_length, libmodi_error_t**error);

       Available when compiled with libbfio support:

       intlibmodi_handle_open_file_io_handle(libmodi_handle_t*handle,     libbfio_handle_t*file_io_handle,
           intaccess_flags, libmodi_error_t**error);

       intlibmodi_handle_open_band_data_files_file_io_pool(libmodi_handle_t*handle, libbfio_pool_t*file_io_pool,
           libmodi_error_t**error);