libqcow.h — Library to access the QEMU Copy-On-Write (QCOW) image file format

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

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

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

       None

       None

       libqcow.h — Library to access the QEMU Copy-On-Write (QCOW) image file format

       libqcow can be compiled with wide character support (wchar_t).

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

       LIBQCOW_WIDE_CHARACTER_TYPE
        in libqcow/features.h can be used to determine if libqcow 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 "libqcow.h".

       the libqcow.h include file

libqcow                                         December 12, 2020                                     libqcow(3)

#include<libqcow.h>

       Support functions

       constchar*libqcow_get_version(void);

       intlibqcow_get_access_flags_read(void);

       intlibqcow_get_access_flags_read_write(void);

       intlibqcow_get_access_flags_write(void);

       intlibqcow_get_codepage(int*codepage, libqcow_error_t**error);

       intlibqcow_set_codepage(intcodepage, libqcow_error_t**error);

       intlibqcow_check_file_signature(constchar*filename, libqcow_error_t**error);

       Available when compiled with wide character string support:

       intlibqcow_check_file_signature_wide(constwchar_t*filename, libqcow_error_t**error);

       Available when compiled with libbfio support:

       intlibqcow_check_file_signature_file_io_handle(libbfio_handle_t*bfio_handle, libqcow_error_t**error);

       Notify functions

       voidlibqcow_notify_set_verbose(intverbose);

       intlibqcow_notify_set_stream(FILE*stream, libqcow_error_t**error);

       intlibqcow_notify_stream_open(constchar*filename, libqcow_error_t**error);

       intlibqcow_notify_stream_close(libqcow_error_t**error);

       Error functions

       voidlibqcow_error_free(libqcow_error_t**error);

       intlibqcow_error_fprint(libqcow_error_t*error, FILE*stream);

       intlibqcow_error_sprint(libqcow_error_t*error, char*string, size_tsize);

       intlibqcow_error_backtrace_fprint(libqcow_error_t*error, FILE*stream);

       intlibqcow_error_backtrace_sprint(libqcow_error_t*error, char*string, size_tsize);

       File functions

       intlibqcow_file_initialize(libqcow_file_t**file, libqcow_error_t**error);

       intlibqcow_file_free(libqcow_file_t**file, libqcow_error_t**error);

       intlibqcow_file_signal_abort(libqcow_file_t*file, libqcow_error_t**error);

       intlibqcow_file_open(libqcow_file_t*file, constchar*filename, intaccess_flags, libqcow_error_t**error);

       intlibqcow_file_close(libqcow_file_t*file, libqcow_error_t**error);

       intlibqcow_file_is_locked(libqcow_file_t*file, libqcow_error_t**error);

       ssize_tlibqcow_file_read_buffer(libqcow_file_t*file,      void*buffer,      size_tbuffer_size,
           libqcow_error_t**error);

       ssize_tlibqcow_file_read_buffer_at_offset(libqcow_file_t*file,    void*buffer,    size_tbuffer_size,
           off64_toffset, libqcow_error_t**error);

       off64_tlibqcow_file_seek_offset(libqcow_file_t*file, off64_toffset, intwhence, libqcow_error_t**error);

       intlibqcow_file_get_offset(libqcow_file_t*file, off64_t*offset, libqcow_error_t**error);

       intlibqcow_file_set_parent_file(libqcow_file_t*file, libqcow_file_t*parent_file, libqcow_error_t**error);

       intlibqcow_file_get_format_version(libqcow_file_t*file, uint32_t*format_version, libqcow_error_t**error);

       intlibqcow_file_get_encryption_method(libqcow_file_t*file,        uint32_t*encryption_method,
           libqcow_error_t**error);

       intlibqcow_file_set_keys(libqcow_file_t*file,     constuint8_t*key,     size_tkey_size,
           libqcow_error_t**error);

       intlibqcow_file_set_utf8_password(libqcow_file_t*file,       constuint8_t*utf8_string,
           size_tutf8_string_length, libqcow_error_t**error);

       intlibqcow_file_set_utf16_password(libqcow_file_t*file,      constuint16_t*utf16_string,
           size_tutf16_string_length, libqcow_error_t**error);

       intlibqcow_file_get_media_size(libqcow_file_t*file, size64_t*media_size, libqcow_error_t**error);

       intlibqcow_file_get_utf8_backing_filename_size(libqcow_file_t*file,      size_t*utf8_string_size,
           libqcow_error_t**error);

       intlibqcow_file_get_utf8_backing_filename(libqcow_file_t*file,         uint8_t*utf8_string,
           size_tutf8_string_size, libqcow_error_t**error);

       intlibqcow_file_get_utf16_backing_filename_size(libqcow_file_t*file,     size_t*utf16_string_size,
           libqcow_error_t**error);

       intlibqcow_file_get_utf16_backing_filename(libqcow_file_t*file,        uint16_t*utf16_string,
           size_tutf16_string_size, libqcow_error_t**error);

       intlibqcow_file_get_number_of_snapshots(libqcow_file_t*file,        int*number_of_snapshots,
           libqcow_error_t**error);

       Available when compiled with wide character string support:

       intlibqcow_file_open_wide(libqcow_file_t*file,    constwchar_t*filename,    intaccess_flags,
           libqcow_error_t**error);

       Available when compiled with libbfio support:

       intlibqcow_file_open_file_io_handle(libqcow_file_t*file,       libbfio_handle_t*file_io_handle,
           intaccess_flags, libqcow_error_t**error);