GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LIBVHDI (3)

NAME

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

CONTENTS

Library
Synopsis
Description
Return Values
Environment
Files
Bugs
Author
Copyright
See Also

LIBRARY


.Lb libvhdi

SYNOPSIS


.In libvhdi.h

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

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

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

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

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

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

Available when compiled with wide character string support: int 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: int 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 int libvhdi_file_get_format_version libvhdi_file_t *file, uint16_t *major_version, uint16_t *minor_version, libvhdi_error_t **error int libvhdi_file_get_disk_type libvhdi_file_t *file, uint32_t *disk_type, libvhdi_error_t **error int libvhdi_file_get_media_size libvhdi_file_t *file, size64_t *media_size, libvhdi_error_t **error int libvhdi_file_get_identifier libvhdi_file_t *file, uint8_t *guid, size_t size, libvhdi_error_t **error int libvhdi_file_get_parent_identifier libvhdi_file_t *file, uint8_t *guid, size_t size, libvhdi_error_t **error int libvhdi_file_get_utf8_parent_filename_size libvhdi_file_t *file, size_t *utf8_string_size, libvhdi_error_t **error int libvhdi_file_get_utf8_parent_filename libvhdi_file_t *file, uint8_t *utf8_string, size_t utf8_string_size, libvhdi_error_t **error int libvhdi_file_get_utf16_parent_filename_size libvhdi_file_t *file, size_t *utf16_string_size, libvhdi_error_t **error int 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 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".

ENVIRONMENT

None

FILES

None 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.

BUGS

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

AUTHOR

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

COPYRIGHT

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

SEE ALSO

the libvhdi.h include file
Search for    or go to Top of page |  Section 3 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.