table of contents
libwtcdb(3) | Library Functions Manual | libwtcdb(3) |
NAME¶
libwtcdb.h
—
Library to access the Windows Explorer thumbnail cache
database (WTCDB) format
SYNOPSIS¶
#include
<libwtcdb.h>
Support functions
const char *
libwtcdb_get_version
(void);
int
libwtcdb_get_access_flags_read
(void);
int
libwtcdb_get_codepage
(int
*codepage,
libwtcdb_error_t
**error);
int
libwtcdb_set_codepage
(int
codepage,
libwtcdb_error_t
**error);
int
libwtcdb_check_file_signature
(const
char *filename,
libwtcdb_error_t
**error);
Available when compiled with wide character string support:
int
libwtcdb_check_file_signature_wide
(const
wchar_t *filename,
libwtcdb_error_t
**error);
Available when compiled with libbfio support:
int
libwtcdb_check_file_signature_file_io_handle
(libbfio_handle_t
*file_io_handle,
libwtcdb_error_t
**error);
Notify functions
void
libwtcdb_notify_set_verbose
(int
verbose);
int
libwtcdb_notify_set_stream
(FILE
*stream, libwtcdb_error_t
**error);
int
libwtcdb_notify_stream_open
(const
char *filename,
libwtcdb_error_t
**error);
int
libwtcdb_notify_stream_close
(libwtcdb_error_t
**error);
Error functions
void
libwtcdb_error_free
(libwtcdb_error_t
**error);
int
libwtcdb_error_fprint
(libwtcdb_error_t
*error, FILE
*stream);
int
libwtcdb_error_sprint
(libwtcdb_error_t
*error, char
*string, size_t
size);
int
libwtcdb_error_backtrace_fprint
(libwtcdb_error_t
*error, FILE
*stream);
int
libwtcdb_error_backtrace_sprint
(libwtcdb_error_t
*error, char
*string, size_t
size);
File functions
int
libwtcdb_file_initialize
(libwtcdb_file_t
**file, libwtcdb_error_t
**error);
int
libwtcdb_file_free
(libwtcdb_file_t
**file, libwtcdb_error_t
**error);
int
libwtcdb_file_signal_abort
(libwtcdb_file_t
*file, libwtcdb_error_t
**error);
int
libwtcdb_file_open
(libwtcdb_file_t
*file, const char
*filename, int
access_flags,
libwtcdb_error_t
**error);
int
libwtcdb_file_close
(libwtcdb_file_t
*file, libwtcdb_error_t
**error);
int
libwtcdb_file_get_type
(libwtcdb_file_t
*file, uint8_t
*type, libwtcdb_error_t
**error);
int
libwtcdb_file_get_number_of_items
(libwtcdb_file_t
*file, int
*number_of_items,
libwtcdb_error_t
**error);
int
libwtcdb_file_get_item
(libwtcdb_file_t
*file, int
item_index,
libwtcdb_item_t **item,
libwtcdb_error_t
**error);
Available when compiled with wide character string support:
int
libwtcdb_file_open_wide
(libwtcdb_file_t
*file, const wchar_t
*filename, int
access_flags,
libwtcdb_error_t
**error);
Available when compiled with libbfio support:
int
libwtcdb_file_open_file_io_handle
(libwtcdb_file_t
*file, libbfio_handle_t
*file_io_handle, int
access_flags,
libwtcdb_error_t
**error);
Item functions
int
libwtcdb_item_free
(libwtcdb_item_t
**item, libwtcdb_error_t
**error);
DESCRIPTION¶
The
libwtcdb_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 "libwtcdb.h".
ENVIRONMENT¶
None
FILES¶
None
NOTES¶
libwtcdb can be compiled with wide character support (wchar_t).
To compile libwtcdb with wide character support use:
./configure --enable-wide-character-type=yes
or define: _UNICODE
or UNICODE
during compilation.
LIBWTCDB_WIDE_CHARACTER_TYPE
in libwtcdb/features.h can be used to determine if libwtcdb was compiled with
wide character support.
BUGS¶
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libwtcdb/issues
AUTHOR¶
These man pages are generated from "libwtcdb.h".
COPYRIGHT¶
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.
SEE ALSO¶
the libwtcdb.h include file
July 29, 2019 | libwtcdb |