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

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

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

       Copyright (C) 2011-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 libvshadow_get_version() function is used to retrieve the library version.

       None

       None

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

       libvshadow can 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.

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

       the libvshadow.h include file

libvshadow                                        March 5, 2019                                    libvshadow(3)

#include<libvshadow.h>

       Support functions

       constchar*libvshadow_get_version(void);

       intlibvshadow_get_access_flags_read(void);

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

       intlibvshadow_set_codepage(intcodepage, libvshadow_error_t**error);

       intlibvshadow_check_volume_signature(constchar*filename, libvshadow_error_t**error);

       Available when compiled with wide character string support:

       intlibvshadow_check_volume_signature_wide(constwchar_t*filename, libvshadow_error_t**error);

       Available when compiled with libbfio support:

       intlibvshadow_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,
           libvshadow_error_t**error);

       Notify functions

       voidlibvshadow_notify_set_verbose(intverbose);

       intlibvshadow_notify_set_stream(FILE*stream, libvshadow_error_t**error);

       intlibvshadow_notify_stream_open(constchar*filename, libvshadow_error_t**error);

       intlibvshadow_notify_stream_close(libvshadow_error_t**error);

       Error functions

       voidlibvshadow_error_free(libvshadow_error_t**error);

       intlibvshadow_error_fprint(libvshadow_error_t*error, FILE*stream);

       intlibvshadow_error_sprint(libvshadow_error_t*error, char*string, size_tsize);

       intlibvshadow_error_backtrace_fprint(libvshadow_error_t*error, FILE*stream);

       intlibvshadow_error_backtrace_sprint(libvshadow_error_t*error, char*string, size_tsize);

       Volume functions

       intlibvshadow_volume_initialize(libvshadow_volume_t**volume, libvshadow_error_t**error);

       intlibvshadow_volume_free(libvshadow_volume_t**volume, libvshadow_error_t**error);

       intlibvshadow_volume_signal_abort(libvshadow_volume_t*volume, libvshadow_error_t**error);

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

       intlibvshadow_volume_close(libvshadow_volume_t*volume, libvshadow_error_t**error);

       intlibvshadow_volume_get_size(libvshadow_volume_t*volume, size64_t*size, libvshadow_error_t**error);

       intlibvshadow_volume_get_number_of_stores(libvshadow_volume_t*volume,      int*number_of_stores,
           libvshadow_error_t**error);

       intlibvshadow_volume_get_store(libvshadow_volume_t*volume,  intstore_index,  libvshadow_store_t**store,
           libvshadow_error_t**error);

       intlibvshadow_volume_get_store_identifier(libvshadow_volume_t*volume,  intstore_index,  uint8_t*guid,
           size_tsize, libvshadow_error_t**error);

       Available when compiled with wide character string support:

       intlibvshadow_volume_open_wide(libvshadow_volume_t*volume,  constwchar_t*filename,  intaccess_flags,
           libvshadow_error_t**error);

       Available when compiled with libbfio support:

       intlibvshadow_volume_open_file_io_handle(libvshadow_volume_t*volume,   libbfio_handle_t*file_io_handle,
           intaccess_flags, libvshadow_error_t**error);

       Store functions

       intlibvshadow_store_free(libvshadow_store_t**store, libvshadow_error_t**error);

       intlibvshadow_store_has_in_volume_data(libvshadow_store_t*store, libvshadow_error_t**error);

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

       ssize_tlibvshadow_store_read_buffer_at_offset(libvshadow_store_t*store,  void*buffer,  size_tbuffer_size,
           off64_toffset, libvshadow_error_t**error);

       off64_tlibvshadow_store_seek_offset(libvshadow_store_t*store,     off64_toffset,      intwhence,
           libvshadow_error_t**error);

       intlibvshadow_store_get_offset(libvshadow_store_t*store, off64_t*offset, libvshadow_error_t**error);

       intlibvshadow_store_get_size(libvshadow_store_t*store, size64_t*size, libvshadow_error_t**error);

       intlibvshadow_store_get_volume_size(libvshadow_store_t*store,         size64_t*volume_size,
           libvshadow_error_t**error);

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

       intlibvshadow_store_get_creation_time(libvshadow_store_t*store,         uint64_t*filetime,
           libvshadow_error_t**error);

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

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

       intlibvshadow_store_get_attribute_flags(libvshadow_store_t*store,      uint32_t*attribute_flags,
           libvshadow_error_t**error);

       intlibvshadow_store_get_number_of_blocks(libvshadow_store_t*store,       int*number_of_blocks,
           libvshadow_error_t**error);

       intlibvshadow_store_get_block_by_index(libvshadow_store_t*store,          intblock_index,
           libvshadow_block_t**block, libvshadow_error_t**error);

       Available when compiled with libbfio support:

       ssize_tlibvshadow_store_read_buffer_from_file_io_handle(libvshadow_store_t*store,
           libbfio_handle_t*file_io_handle, void*buffer, size_tbuffer_size, libvshadow_error_t**error);

       Block functions

       intlibvshadow_block_free(libvshadow_block_t**block, libvshadow_error_t**error);

       intlibvshadow_block_get_original_offset(libvshadow_block_t*block,      off64_t*original_offset,
           libvshadow_error_t**error);

       intlibvshadow_block_get_relative_offset(libvshadow_block_t*block,      off64_t*relative_offset,
           libvshadow_error_t**error);

       intlibvshadow_block_get_offset(libvshadow_block_t*block, off64_t*offset, libvshadow_error_t**error);

       intlibvshadow_block_get_values(libvshadow_block_t*block,         off64_t*original_offset,
           off64_t*relative_offset,     off64_t*offset,    uint32_t*flags,    uint32_t*bitmap,
           libvshadow_error_t**error);