NAME

       libvmdk.h — Library to access the VMware Virtual Disk (VMDK) format

LIBRARY

       library “libvmdk”

SYNOPSIS

       #include <libvmdk.h>

       Support functions

       const char *
       libvmdk_get_version(void);

       int
       libvmdk_get_access_flags_read(void);

       int
       libvmdk_get_codepage(int *codepage, libvmdk_error_t **error);

       int
       libvmdk_set_codepage(int codepage, libvmdk_error_t **error);

       int
       libvmdk_check_file_signature(const char *filename, libvmdk_error_t **error);

       Available when compiled with wide character string support:

       int
       libvmdk_check_file_signature_wide(const wchar_t *filename, libvmdk_error_t **error);

       Available when compiled with libbfio support:

       int
       libvmdk_check_file_signature_file_io_handle(libbfio_handle_t *file_io_handle, libvmdk_error_t **error);

       Notify functions

       void
       libvmdk_notify_set_verbose(int verbose);

       int
       libvmdk_notify_set_stream(FILE *stream, libvmdk_error_t **error);

       int
       libvmdk_notify_stream_open(const char *filename, libvmdk_error_t **error);

       int
       libvmdk_notify_stream_close(libvmdk_error_t **error);

       Error functions

       void
       libvmdk_error_free(libvmdk_error_t **error);

       int
       libvmdk_error_fprint(libvmdk_error_t *error, FILE *stream);

       int
       libvmdk_error_sprint(libvmdk_error_t *error, char *string, size_t size);

       int
       libvmdk_error_backtrace_fprint(libvmdk_error_t *error, FILE *stream);

       int
       libvmdk_error_backtrace_sprint(libvmdk_error_t *error, char *string, size_t size);

       Handle functions

       int
       libvmdk_handle_initialize(libvmdk_handle_t **handle, libvmdk_error_t **error);

       int
       libvmdk_handle_free(libvmdk_handle_t **handle, libvmdk_error_t **error);

       int
       libvmdk_handle_signal_abort(libvmdk_handle_t *handle, libvmdk_error_t **error);

       int
       libvmdk_handle_open(libvmdk_handle_t*handle,constchar*filename,intaccess_flags, libvmdk_error_t **error);

       int
       libvmdk_handle_open_extent_data_files(libvmdk_handle_t *handle, libvmdk_error_t **error);

       int
       libvmdk_handle_close(libvmdk_handle_t *handle, libvmdk_error_t **error);

       ssize_t
       libvmdk_handle_read_buffer(libvmdk_handle_t*handle,void*buffer,size_tbuffer_size,libvmdk_error_t**error);

       ssize_t
       libvmdk_handle_read_buffer_at_offset(libvmdk_handle*_tandlveo*,ibduffesri,zeb_tffer_sizoef,f64_tffsetl,ibvmdk_error_t*error);

       ssize_t
       libvmdk_handle_write_buffer(libvmdk_handle_t*handle,constvoid*buffer,size_tbuffer_size,libvmdk_error_t**error);

       ssize_t
       libvmdk_handle_write_buffer_at_offset(libvmdk_handle*_tandlceo,nvso*tibduffesri,zeb_tffer_sizoef,f64o_tfselti,bvmdk_error*_terror);

       off64_t
       libvmdk_handle_seek_offset(libvmdk_handle_t *handle, off64_t offset, int whence, libvmdk_error_t**error);

       int
       libvmdk_handle_get_offset(libvmdk_handle_t *handle, off64_t *offset, libvmdk_error_t **error);

       int
       libvmdk_handle_set_maximum_number_of_open_handles(libvmdk_han*mdhalaixenni_tmtluem,_number_of_open_handlliebsv,mdk_err*o*re_tror);

       int
       libvmdk_handle_set_parent_handle(libvmdk_handle_t*handle,libvmdk_handle_t*parent_handlel,ibvmdk_error_t*error);

       Available when compiled with wide character string support:

       int
       libvmdk_handle_open_wide(libvmdk_handle_t*handle,constwchar_t*filename,intaccess_flags,libvmdk_error_t**error);

       Available when compiled with libbfio support:

       int
       libvmdk_handle_open_file_io_handle(libvmdk_handle*_tandllei,bbfio_handl*ef_tle_io_hanadiclncete,ss_flalgisb,vmdk_erro*r*_trror);

       int
       libvmdk_handle_open_extent_data_files_file_io_pool(libvmdk_hand*lhea_ltdilbeb,fio_poo*lf_tle_io_poloilb,vmdk_erro*r*_trror);

       Meta data functions

       int
       libvmdk_handle_get_disk_type(libvmdk_handle_t *handle, int *disk_type, libvmdk_error_t **error);

       int
       libvmdk_handle_get_media_size(libvmdk_handle_t *handle, size64_t *media_size, libvmdk_error_t **error);

       int
       libvmdk_handle_get_content_identifier(libvmdk_handle_t*handleu,int32_tcontent_identifierl,ibvmdk_error_t*error);

       int
       libvmdk_handle_get_parent_content_identifier(libvmdk_hand*lhea_utdilnet*,3p2a_tent_content_identifileirb,vmdk_erro*r*_trror);

       int
       libvmdk_handle_get_utf8_parent_filename_size(libvmdk_handle_thandles,ize_tutf8_string_sizlei,bvmdk_error*_terror);

       int
       libvmdk_handle_get_utf8_parent_filename(libvmdk_handl*eh_tndulien,t*8u_tf8_strisnigzu,et_t8_string_sizlei,bvmdk_error*_terror);

       int
       libvmdk_handle_get_utf16_parent_filename_size(libvmdk_handle_thandlsei,ze*_ttf16_string_sizlei,bvmdk_error*_terror);

       int
       libvmdk_handle_get_utf16_parent_filename(libvmdk_hand*lhea_utdilnet,1*6u_tf16_strisnigzu,et_t16_string_silzieb,vmdk_erro*r*_trror);

       int
       libvmdk_handle_get_number_of_extents(libvmdk_handle_t*handle,int*number_of_extents,libvmdk_error_t**error);

       int
       libvmdk_handle_get_extent_descriptor(libvmdk_hea*xnhtdaielnnnedtt__teil,nidbevxm,dk_extent_descrip*t*oerx_tent_descrilpitbovrm,dk_er*r*oerr_tor);

       Extent descriptor functions

       int
       libvmdk_extent_descriptor_free(libvmdk_extent_descriptor_t **extent_descriptor, libvmdk_error_t **error);

       int
       libvmdk_extent_descriptor_get_type(libvmdk_extent_descriptor_t*extent_descriptori,n*ttypel,ibvmdk_error_t*error);

       int
       libvmdk_extent_descriptor_get_range(libvmdk_extent_descript*oerx_tent_descripotfofr6*,4o_tfsseitz,e6*4s_ltzieb,vmdk_erro*r*_trror);

       int
       libvmdk_extent_descriptor_get_utf8_filename_size(libvmdk_extent_descri*petxotre_tt_des*curstiifpz8te_o_rtt,rinlgi_svimzdek,_e*rerrorro_tint
       libvmdk_extent_descriptor_get_utf8_filename(libvmdk_extent_descr*iepxttoern_t_des*cuuritinfpt8t8_o_strttif,rz8ie_n_gtt,ringl_sbivzmed,k_e*r*reorrr_tr);

       int
       libvmdk_extent_descriptor_get_utf16_filename_size(libvmdk_extent_descr*iepxttoern_t_de*sucstrifiz1pe6t_otsrt,rinlgi_svimzdek,_e*rerrorro_tint
       libvmdk_extent_descriptor_get_utf16_filename(libvmdk_extent_descr*iepxttoern_t_descu*riuintptft11uo66tr_f,tsi1tz6re_i_nttgr,inlgi_svimzdek,_e*rerrorro_t
DESCRIPTION
       The libvmdk_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 "libvmdk.h".

ENVIRONMENT
       None

FILES
       None

NOTES
       libvmdk allows to be compiled with wide character support (wchar_t).

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

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

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

AUTHOR
       These man pages are generated from "libvmdk.h".

COPYRIGHT
       Copyright (C) 2009-2017, 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 libvmdk.h include file

libvmdk                                         November 8, 2016                                      libvmdk(3)