NAME

       libvshadow.h — Library to access the Windows NT Volume Shadow Snapshot (VSS) format

LIBRARY

       library “libvshadow”

SYNOPSIS

       #include <libvshadow.h>

       Support functions

       const char *
       libvshadow_get_version(void);

       int
       libvshadow_get_access_flags_read(void);

       int
       libvshadow_get_codepage(int *codepage, libvshadow_error_t **error);

       int
       libvshadow_set_codepage(int codepage, libvshadow_error_t **error);

       int
       libvshadow_check_volume_signature(const char *filename, libvshadow_error_t **error);

       Available when compiled with wide character string support:

       int
       libvshadow_check_volume_signature_wide(const wchar_t *filename, libvshadow_error_t **error);

       Available when compiled with libbfio support:

       int
       libvshadow_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,libvshadow_error_t**error);

       Notify functions

       void
       libvshadow_notify_set_verbose(int verbose);

       int
       libvshadow_notify_set_stream(FILE *stream, libvshadow_error_t **error);

       int
       libvshadow_notify_stream_open(const char *filename, libvshadow_error_t **error);

       int
       libvshadow_notify_stream_close(libvshadow_error_t **error);

       Error functions

       void
       libvshadow_error_free(libvshadow_error_t **error);

       int
       libvshadow_error_fprint(libvshadow_error_t *error, FILE *stream);

       int
       libvshadow_error_sprint(libvshadow_error_t *error, char *string, size_t size);

       int
       libvshadow_error_backtrace_fprint(libvshadow_error_t *error, FILE *stream);

       int
       libvshadow_error_backtrace_sprint(libvshadow_error_t *error, char *string, size_t size);

       Volume functions

       int
       libvshadow_volume_initialize(libvshadow_volume_t **volume, libvshadow_error_t **error);

       int
       libvshadow_volume_free(libvshadow_volume_t **volume, libvshadow_error_t **error);

       int
       libvshadow_volume_signal_abort(libvshadow_volume_t *volume, libvshadow_error_t **error);

       int
       libvshadow_volume_open(libvshadow_volume_t*volume,constchar*filename,intaccess_flags,libvshadow_error_t**error);

       int
       libvshadow_volume_close(libvshadow_volume_t *volume, libvshadow_error_t **error);

       int
       libvshadow_volume_get_size(libvshadow_volume_t *volume, size64_t *size, libvshadow_error_t **error);

       int
       libvshadow_volume_get_number_of_stores(libvshadow_volume_tvolumei,n*tnumber_of_storesl,ibvshadow_error_t**error);

       int
       libvshadow_volume_get_store(libvshadow_volume_tvolumei,nsttore_indelxi,bvshadow_store*_tstorlei,bvshadow_error*_terror);

       int
       libvshadow_volume_get_store_identifier(libvshadow_volume*_tolumisent,tore_indeuxi,nt8*_tuisdi,zes_tzlei,bvshadow_error*_terror);

       Available when compiled with wide character string support:

       int
       libvshadow_volume_open_wide(libvshadow_volume_t*volumec,onswtchar_tfilenamei,natccess_flagsl,ibvshadow_error_t*error);

       Available when compiled with libbfio support:

       int
       libvshadow_volume_open_file_io_handle(libvshadow_volu*mveo_ltuimbeb,fio_hand*lfei_te_io_haacnicdneltses,_fllaigbsv,shadow_err*o*re_tror);

       Store functions

       int
       libvshadow_store_free(libvshadow_store_t **store, libvshadow_error_t **error);

       int
       libvshadow_store_has_in_volume_data(libvshadow_store_t *store, libvshadow_error_t **error);

       ssize_t
       libvshadow_store_read_buffer(libvshadow_store_t*store,void*buffer,size_tbuffer_size,libvshadow_error_t**error);

       ssize_t
       libvshadow_store_read_buffer_at_offset(libvshadow_stor*es_tov*robeiu,dffesri,zeb_tffer_sizoef,f64o_tfselti,bvshadow_error*_terror);

       off64_t
       libvshadow_store_seek_offset(libvshadow_store_t*store,off64_toffset,intwhence,libvshadow_error_t**error);

       int
       libvshadow_store_get_offset(libvshadow_store_t *store, off64_t *offset, libvshadow_error_t **error);

       int
       libvshadow_store_get_size(libvshadow_store_t *store, size64_t *size, libvshadow_error_t **error);

       int
       libvshadow_store_get_volume_size(libvshadow_store_t*store,size64_t*volume_size,libvshadow_error_t**error);

       int
       libvshadow_store_get_identifier(libvshadow_store_t*store,uint8_t*guid,size_tsize,libvshadow_error_t**error);

       int
       libvshadow_store_get_creation_time(libvshadow_store_t*store,uint64_t*filetime,libvshadow_error_t**error);

       int
       libvshadow_store_get_copy_identifier(libvshadow_store_t*store,uint8_t*guid,size_tsize,libvshadow_error_t*error);

       int
       libvshadow_store_get_copy_set_identifier(libvshadow_store_tstoreu,int8_tguids,ize_tize,libvshadow_error_t**error);

       int
       libvshadow_store_get_attribute_flags(libvshadow_store_t*storeu,int32_tattribute_flagsl,ibvshadow_error_t*error);

       int
       libvshadow_store_get_number_of_blocks(libvshadow_store_tstore,int*number_of_blocks,libvshadow_error_t**error);

       int
       libvshadow_store_get_block_by_index(libvshadow_store*_ttoribenl,tock_indelxi,bvshadow_bloc*k*_tlolcikb,vshadow_erro*r*_trror);

       Available when compiled with libbfio support:

       ssize_t
       libvshadow_store_read_buffer_from_file_io_handle(libvshadow_s*ltsiotbroberf_it,o_ha*nfdillee_tio*_hvusbaofiunifzfddeeflr_e,tr,_siibzves,hadow_er*r*oerr_tor);

       Block functions

       int
       libvshadow_block_free(libvshadow_block_t **block, libvshadow_error_t **error);

       int
       libvshadow_block_get_original_offset(libvshadow_block_t*block,off64_toriginal_offsetl,ibvshadow_error_t*error);

       int
       libvshadow_block_get_relative_offset(libvshadow_block_tblocko,ff64_trelative_offset,libvshadow_error_t**error);

       int
       libvshadow_block_get_offset(libvshadow_block_t *block, off64_t *offset, libvshadow_error_t **error);

       int
       libvshadow_block_get_values(libvshadow_blo*cbklo_ftcf*k6o,4r_tginal_offosfef*t6r,4e_tative_offosfef*t6o,4f_utsientt*,3fu2li_n*tgtbs3il,2ti_btavps,hadow_er*r*oerr_tor);

DESCRIPTION

       The libvshadow_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 "libvshadow.h".

ENVIRONMENT

       None

FILES

       None libvshadow allows to be compiled with wide character support (wchar_t).

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

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

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2011-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 libvshadow.h include file

libvshadow                                       January 9, 2016                                   libvshadow(3)