libvhdi.h — Library to access the Virtual Hard Disk (VHD) image format

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

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

       None

       None

       libvhdi.h — Library to access the Virtual Hard Disk (VHD) image format

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

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

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

       the libvhdi.h include file

libvhdi                                         December 12, 2020                                     libvhdi(3)

#include<libvhdi.h>

       Support functions

       constchar*libvhdi_get_version(void);

       intlibvhdi_get_access_flags_read(void);

       intlibvhdi_get_access_flags_read_write(void);

       intlibvhdi_get_access_flags_write(void);

       intlibvhdi_get_codepage(int*codepage, libvhdi_error_t**error);

       intlibvhdi_set_codepage(intcodepage, libvhdi_error_t**error);

       intlibvhdi_check_file_signature(constchar*filename, libvhdi_error_t**error);

       Available when compiled with wide character string support:

       intlibvhdi_check_file_signature_wide(constwchar_t*filename, libvhdi_error_t**error);

       Available when compiled with libbfio support:

       intlibvhdi_check_file_signature_file_io_handle(libbfio_handle_t*file_io_handle, libvhdi_error_t**error);

       Notify functions

       voidlibvhdi_notify_set_verbose(intverbose);

       intlibvhdi_notify_set_stream(FILE*stream, libvhdi_error_t**error);

       intlibvhdi_notify_stream_open(constchar*filename, libvhdi_error_t**error);

       intlibvhdi_notify_stream_close(libvhdi_error_t**error);

       Error functions

       voidlibvhdi_error_free(libvhdi_error_t**error);

       intlibvhdi_error_fprint(libvhdi_error_t*error, FILE*stream);

       intlibvhdi_error_sprint(libvhdi_error_t*error, char*string, size_tsize);

       intlibvhdi_error_backtrace_fprint(libvhdi_error_t*error, FILE*stream);

       intlibvhdi_error_backtrace_sprint(libvhdi_error_t*error, char*string, size_tsize);

       File functions

       intlibvhdi_file_initialize(libvhdi_file_t**file, libvhdi_error_t**error);

       intlibvhdi_file_free(libvhdi_file_t**file, libvhdi_error_t**error);

       intlibvhdi_file_signal_abort(libvhdi_file_t*file, libvhdi_error_t**error);

       intlibvhdi_file_open(libvhdi_file_t*file, constchar*filename, intaccess_flags, libvhdi_error_t**error);

       intlibvhdi_file_close(libvhdi_file_t*file, libvhdi_error_t**error);

       ssize_tlibvhdi_file_read_buffer(libvhdi_file_t*file,      void*buffer,      size_tbuffer_size,
           libvhdi_error_t**error);

       ssize_tlibvhdi_file_read_buffer_at_offset(libvhdi_file_t*file,    void*buffer,    size_tbuffer_size,
           off64_toffset, libvhdi_error_t**error);

       off64_tlibvhdi_file_seek_offset(libvhdi_file_t*file, off64_toffset, intwhence, libvhdi_error_t**error);

       intlibvhdi_file_get_offset(libvhdi_file_t*file, off64_t*offset, libvhdi_error_t**error);

       intlibvhdi_file_set_parent_file(libvhdi_file_t*file, libvhdi_file_t*parent_file, libvhdi_error_t**error);

       Available when compiled with wide character string support:

       intlibvhdi_file_open_wide(libvhdi_file_t*file,    constwchar_t*filename,    intaccess_flags,
           libvhdi_error_t**error);

       Available when compiled with libbfio support:

       intlibvhdi_file_open_file_io_handle(libvhdi_file_t*file,       libbfio_handle_t*file_io_handle,
           intaccess_flags, libvhdi_error_t**error);

       Meta data functions

       intlibvhdi_file_get_file_type(libvhdi_file_t*file, int*file_type, libvhdi_error_t**error);

       intlibvhdi_file_get_format_version(libvhdi_file_t*file,  uint16_t*major_version, uint16_t*minor_version,
           libvhdi_error_t**error);

       intlibvhdi_file_get_disk_type(libvhdi_file_t*file, uint32_t*disk_type, libvhdi_error_t**error);

       intlibvhdi_file_get_media_size(libvhdi_file_t*file, size64_t*media_size, libvhdi_error_t**error);

       intlibvhdi_file_get_bytes_per_sector(libvhdi_file_t*file,        uint32_t*bytes_per_sector,
           libvhdi_error_t**error);

       intlibvhdi_file_get_identifier(libvhdi_file_t*file,    uint8_t*guid_data,   size_tguid_data_size,
           libvhdi_error_t**error);

       intlibvhdi_file_get_parent_identifier(libvhdi_file_t*file,  uint8_t*guid_data,  size_tguid_data_size,
           libvhdi_error_t**error);

       intlibvhdi_file_get_utf8_parent_filename_size(libvhdi_file_t*file,      size_t*utf8_string_size,
           libvhdi_error_t**error);

       intlibvhdi_file_get_utf8_parent_filename(libvhdi_file_t*file,         uint8_t*utf8_string,
           size_tutf8_string_size, libvhdi_error_t**error);

       intlibvhdi_file_get_utf16_parent_filename_size(libvhdi_file_t*file,     size_t*utf16_string_size,
           libvhdi_error_t**error);

       intlibvhdi_file_get_utf16_parent_filename(libvhdi_file_t*file,        uint16_t*utf16_string,
           size_tutf16_string_size, libvhdi_error_t**error);