LIBRARY

Lb libvhdi

SYNOPSIS

In libvhdi.h

Support functions Ft const char * Fn libvhdi_get_version void Ft int Fn libvhdi_get_access_flags_read void Ft int Fn libvhdi_get_access_flags_read_write void Ft int Fn libvhdi_get_access_flags_write void Ft int Fn libvhdi_get_codepage int *codepage, libvhdi_error_t **error Ft int Fn libvhdi_set_codepage int codepage, libvhdi_error_t **error Ft int Fn libvhdi_check_file_signature const char *filename, libvhdi_error_t **error

Available when compiled with wide character string support: Ft int Fn libvhdi_check_file_signature_wide const wchar_t *filename, libvhdi_error_t **error

Available when compiled with libbfio support: Ft int Fn libvhdi_check_file_signature_file_io_handle libbfio_handle_t *file_io_handle, libvhdi_error_t **error

Notify functions Ft void Fn libvhdi_notify_set_verbose int verbose Ft int Fn libvhdi_notify_set_stream FILE *stream, libvhdi_error_t **error Ft int Fn libvhdi_notify_stream_open const char *filename, libvhdi_error_t **error Ft int Fn libvhdi_notify_stream_close libvhdi_error_t **error

Error functions Ft void Fn libvhdi_error_free libvhdi_error_t **error Ft int Fn libvhdi_error_fprint libvhdi_error_t *error, FILE *stream Ft int Fn libvhdi_error_sprint libvhdi_error_t *error, char *string, size_t size Ft int Fn libvhdi_error_backtrace_fprint libvhdi_error_t *error, FILE *stream Ft int Fn libvhdi_error_backtrace_sprint libvhdi_error_t *error, char *string, size_t size

File functions Ft int Fn libvhdi_file_initialize libvhdi_file_t **file, libvhdi_error_t **error Ft int Fn libvhdi_file_free libvhdi_file_t **file, libvhdi_error_t **error Ft int Fn libvhdi_file_signal_abort libvhdi_file_t *file, libvhdi_error_t **error Ft int Fn libvhdi_file_open libvhdi_file_t *file, const char *filename, int access_flags, libvhdi_error_t **error Ft int Fn libvhdi_file_close libvhdi_file_t *file, libvhdi_error_t **error Ft ssize_t Fn libvhdi_file_read_buffer libvhdi_file_t *file, void *buffer, size_t buffer_size, libvhdi_error_t **error Ft ssize_t Fn libvhdi_file_read_buffer_at_offset libvhdi_file_t *file, void *buffer, size_t buffer_size, off64_t offset, libvhdi_error_t **error Ft ssize_t Fn libvhdi_file_write_buffer libvhdi_file_t *file, const void *buffer, size_t buffer_size, libvhdi_error_t **error Ft ssize_t Fn libvhdi_file_write_buffer_add_offset libvhdi_file_t *file, const void *buffer, size_t buffer_size, off64_t offset, libvhdi_error_t **error Ft off64_t Fn libvhdi_file_seek_offset libvhdi_file_t *file, off64_t offset, int whence, libvhdi_error_t **error Ft int Fn libvhdi_file_get_offset libvhdi_file_t *file, off64_t *offset, libvhdi_error_t **error

Available when compiled with wide character string support: Ft int Fn libvhdi_file_open_wide libvhdi_file_t *file, const wchar_t *filename, int access_flags, libvhdi_error_t **error

Available when compiled with libbfio support: Ft int Fn libvhdi_file_open_file_io_handle libvhdi_file_t *file, libbfio_handle_t *file_io_handle, int access_flags, libvhdi_error_t **error

Meta data functions Ft int Fn libvhdi_file_get_format_version libvhdi_file_t *file, uint16_t *major_version, uint16_t *minor_version, libvhdi_error_t **error Ft int Fn libvhdi_file_get_disk_type libvhdi_file_t *file, uint32_t *disk_type, libvhdi_error_t **error Ft int Fn libvhdi_file_get_media_size libvhdi_file_t *file, size64_t *media_size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_identifier libvhdi_file_t *file, uint8_t *guid, size_t size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_parent_identifier libvhdi_file_t *file, uint8_t *guid, size_t size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_utf8_parent_filename_size libvhdi_file_t *file, size_t *utf8_string_size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_utf8_parent_filename libvhdi_file_t *file, uint8_t *utf8_string, size_t utf8_string_size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_utf16_parent_filename_size libvhdi_file_t *file, size_t *utf16_string_size, libvhdi_error_t **error Ft int Fn libvhdi_file_get_utf16_parent_filename libvhdi_file_t *file, uint16_t *utf16_string, size_t utf16_string_size, libvhdi_error_t **error

DESCRIPTION

The Fn libvhdi_get_version function is used to retrieve the library version.

RETURN VALUES

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

FILES

None

NOTES

libvhdi allows to 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.

AUTHOR

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

COPYRIGHT

Copyright (C) 2012-2016, Joachim Metz <[email protected]>.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.