NAME

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

LIBRARY

       library “libqcow”

SYNOPSIS

       #include <libqcow.h>

       Support functions

       const char *
       libqcow_get_version(void);

       int
       libqcow_get_access_flags_read(void);

       int
       libqcow_get_access_flags_read_write(void);

       int
       libqcow_get_access_flags_write(void);

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

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

       int
       libqcow_check_file_signature(const char *filename, libqcow_error_t **error);

       Available when compiled with wide character string support:

       int
       libqcow_check_file_signature_wide(const wchar_t *filename, libqcow_error_t **error);

       Available when compiled with libbfio support:

       int
       libqcow_check_file_signature_file_io_handle(libbfio_handle_t *bfio_handle, libqcow_error_t **error);

       Notify functions

       void
       libqcow_notify_set_verbose(int verbose);

       int
       libqcow_notify_set_stream(FILE *stream, libqcow_error_t **error);

       int
       libqcow_notify_stream_open(const char *filename, libqcow_error_t **error);

       int
       libqcow_notify_stream_close(libqcow_error_t **error);

       Error functions

       void
       libqcow_error_free(libqcow_error_t **error);

       int
       libqcow_error_fprint(libqcow_error_t *error, FILE *stream);

       int
       libqcow_error_sprint(libqcow_error_t *error, char *string, size_t size);

       int
       libqcow_error_backtrace_fprint(libqcow_error_t *error, FILE *stream);

       int
       libqcow_error_backtrace_sprint(libqcow_error_t *error, char *string, size_t size);

       File functions

       int
       libqcow_file_initialize(libqcow_file_t **file, libqcow_error_t **error);

       int
       libqcow_file_free(libqcow_file_t **file, libqcow_error_t **error);

       int
       libqcow_file_signal_abort(libqcow_file_t *file, libqcow_error_t **error);

       int
       libqcow_file_open(libqcow_file_t *file, const char *filename, int access_flags, libqcow_error_t **error);

       int
       libqcow_file_close(libqcow_file_t *file, libqcow_error_t **error);

       ssize_t
       libqcow_file_read_buffer(libqcow_file_t*file, void *buffer, size_t buffer_size, libqcow_error_t **error);

       ssize_t
       libqcow_file_read_buffer_at_offset(libqcow_file_tfilev,oi*dbuffers,ize_tuffer_sizeo,ff64_tffsetl,ibqcow_error_t*error);

       ssize_t
       libqcow_file_write_buffer(libqcow_file_t*file,constvoid*buffer,size_tbuffer_size,libqcow_error_t**error);

       ssize_t
       libqcow_file_write_buffer_at_offset(libqcow_file_tfilec,onsvtoi*dbuffers,ize_tuffer_sizoef,f64o_tfselti,bqcow_error*_terror);

       off64_t
       libqcow_file_seek_offset(libqcow_file_t *file, off64_t offset, int whence, libqcow_error_t **error);

       int
       libqcow_file_get_offset(libqcow_file_t *file, off64_t *offset, libqcow_error_t **error);

       int
       libqcow_file_get_format_version(libqcow_file_t *file, uint32_t *format_version, libqcow_error_t **error);

       int
       libqcow_file_get_encryption_method(libqcow_file_t*file,uint32_t*encryption_method,libqcow_error_t**error);

       int
       libqcow_file_set_keys(libqcow_file_t *file, const uint8_t *key, size_t key_size, libqcow_error_t**error);

       int
       libqcow_file_set_utf8_password(libqcow_file*_tilceo,nusitnt8*_ttf8_strings,ize_ttf8_string_lengthl,ibqcow_error_t*error);

       int
       libqcow_file_set_utf16_password(libqcow_file*_tilceo,nusitnt16*_ttf16_strinsgi,zeu_tf16_string_lengtlhi,bqcow_error*_terror);

       Available when compiled with wide character string support:

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

       Available when compiled with libbfio support:

       int
       libqcow_file_open_file_io_handle(libqcow_file_tfillei,bbfio_handle*_tile_io_handliaenc,tcess_flaglsi,bqcow_error*_terror);

       Meta data functions

       int
       libqcow_file_get_media_size(libqcow_file_t *file, size64_t *media_size, libqcow_error_t **error);

DESCRIPTION

       The libqcow_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 "libqcow.h".

ENVIRONMENT

       None

FILES

       None libqcow allows to 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.

BUGS

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

AUTHOR

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

COPYRIGHT

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

libqcow                                          January 5, 2015                                      libqcow(3)