NAME

libesedb.h - Library to support the Extensible Storage Engine (ESE) Database File (EDB) format

LIBRARY

Lb libesedb

SYNOPSIS

In libesedb.h

Support functions Ft const char * Fn libesedb_get_version void Ft int Fn libesedb_get_access_flags_read Ft int Fn libesedb_get_codepage int *codepage, libesedb_error_t **error Ft int Fn libesedb_set_codepage int codepage, libesedb_error_t **error Ft int Fn libesedb_check_file_signature const char *filename, libesedb_error_t **error

Available when compiled with wide character string support: Ft int Fn libesedb_check_file_signature_wide const wchar_t *filename, libesedb_error_t **error

Available when compiled with libbfio support: Ft int Fn libesedb_check_file_signature_file_io_handle libbfio_handle_t *bfio_handle, libesedb_error_t **error

Notify functions Ft void Fn libesedb_notify_set_verbose int verbose Ft int Fn libesedb_notify_set_stream FILE *stream, libesedb_error_t **error Ft int Fn libesedb_notify_stream_open const char *filename, libesedb_error_t **error Ft int Fn libesedb_notify_stream_close libesedb_error_t **error

Error functions Ft void Fn libesedb_error_free libesedb_error_t **error Ft int Fn libesedb_error_fprint libesedb_error_t *error, FILE *stream Ft int Fn libesedb_error_sprint libesedb_error_t *error, char *string, size_t size Ft int Fn libesedb_error_backtrace_fprint libesedb_error_t *error, FILE *stream Ft int Fn libesedb_error_backtrace_sprint libesedb_error_t *error, char *string, size_t size

File functions Ft int Fn libesedb_file_initialize libesedb_file_t **file, libesedb_error_t **error Ft int Fn libesedb_file_free libesedb_file_t **file, libesedb_error_t **error Ft int Fn libesedb_file_open libesedb_file_t *file, const char *filename, int flags, libesedb_error_t **error Ft int Fn libesedb_file_close libesedb_file_t *file, libesedb_error_t **error Ft int Fn libesedb_file_get_type libesedb_file_t *file, uint32_t *type, libesedb_error_t **error Ft int Fn libesedb_file_get_format_version libesedb_file_t *file, uint32_t *format_version, uint32_t *format_revision, libesedb_error_t **error Ft int Fn libesedb_file_get_creation_format_version libesedb_file_t *file, uint32_t *format_version, uint32_t *format_revision, libesedb_error_t **error Ft int Fn libesedb_file_get_page_size libesedb_file_t *file, uint32_t *page_size, libesedb_error_t **error Ft int Fn libesedb_file_get_number_of_tables libesedb_file_t *file, int *number_of_tables, libesedb_error_t **error Ft int Fn libesedb_file_get_table libesedb_file_t *file, int table_entry, libesedb_table_t **table, libesedb_error_t **error Ft int Fn libesedb_file_get_table_by_utf8_name libesedb_file_t *file, const uint8_t *utf8_string, size_t utf8_string_length, libesedb_table_t **table, libesedb_error_t **error Ft int Fn libesedb_file_get_table_by_utf16_name libesedb_file_t *file, const uint16_t *utf16_string, size_t utf16_string_length, libesedb_table_t **table, libesedb_error_t **error

Available when compiled with wide character string support: Ft int Fn libesedb_file_open_wide libesedb_file_t *file, const wchar_t *filename, int flags, libesedb_error_t **error

Available when compiled with libbfio support: Ft int Fn libesedb_file_open_file_io_handle libesedb_file_t *file, libbfio_handle_t *file_io_handle, int flags, libesedb_error_t **error

Table functions Ft int Fn libesedb_table_free libesedb_table_t **table, libesedb_error_t **error Ft int Fn libesedb_table_get_identifier libesedb_table_t *table, uint32_t *identifier, libesedb_error_t **error Ft int Fn libesedb_table_get_utf8_name_size libesedb_table_t *table, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf8_name libesedb_table_t *table, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf16_name_size libesedb_table_t *table, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf16_name libesedb_table_t *table, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf8_template_name_size libesedb_table_t *table, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf8_template_name libesedb_table_t *table, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf16_template_name_size libesedb_table_t *table, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_utf16_template_name libesedb_table_t *table, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_table_get_number_of_columns libesedb_table_t *table, int *number_of_columns, uint8_t flags, libesedb_error_t **error Ft int Fn libesedb_table_get_column libesedb_table_t *table, int column_entry, libesedb_column_t **column, uint8_t flags, libesedb_error_t **error Ft int Fn libesedb_table_get_number_of_indexes libesedb_table_t *table, int *number_of_indexes, libesedb_error_t **error Ft int Fn libesedb_table_get_index libesedb_table_t *table, int index_entry, libesedb_index_t **index, libesedb_error_t **error Ft int Fn libesedb_table_get_number_of_records libesedb_table_t *table, int *number_of_records, libesedb_error_t **error Ft int Fn libesedb_table_get_record libesedb_table_t *table, int record_entry, libesedb_record_t **record, libesedb_error_t **error

Column functions Ft int Fn libesedb_column_free libesedb_column_t **column, libesedb_error_t **error Ft int Fn libesedb_column_get_identifier libesedb_column_t *column, uint32_t *identifier, libesedb_error_t **error Ft int Fn libesedb_column_get_type libesedb_column_t *column, uint32_t *type, libesedb_error_t **error Ft int Fn libesedb_column_get_utf8_name_size libesedb_column_t *column, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_column_get_utf8_name libesedb_column_t *column, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_column_get_utf16_name_size libesedb_column_t *column, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_column_get_utf16_name libesedb_column_t *column, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error

Index functions Ft int Fn libesedb_index_free libesedb_index_t **index, libesedb_error_t **error Ft int Fn libesedb_index_get_identifier libesedb_index_t *index, uint32_t *identifier, libesedb_error_t **error Ft int Fn libesedb_index_get_utf8_name_size libesedb_index_t *index, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_index_get_utf8_name libesedb_index_t *index, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_index_get_utf16_name_size libesedb_index_t *index, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_index_get_utf16_name libesedb_index_t *index, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_index_get_number_of_records libesedb_index_t *index, int *number_of_records, libesedb_error_t **error Ft int Fn libesedb_index_get_record libesedb_index_t *index, int record_entry, libesedb_record_t **record, libesedb_error_t **error

Record functions Ft int Fn libesedb_record_free libesedb_record_t **record, libesedb_error_t **error Ft int Fn libesedb_record_get_number_of_values libesedb_record_t *record, int *number_of_values, libesedb_error_t **error Ft int Fn libesedb_record_get_column_identifier libesedb_record_t *record, int value_entry, uint32_t *column_identifier, libesedb_error_t **error Ft int Fn libesedb_record_get_column_type libesedb_record_t *record, int value_entry, uint32_t *column_type, libesedb_error_t **error Ft int Fn libesedb_record_get_utf8_column_name_size libesedb_record_t *record, int value_entry, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_utf8_column_name libesedb_record_t *record, int value_entry, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_utf16_column_name_size libesedb_record_t *record, int value_entry, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_utf16_column_name libesedb_record_t *record, int value_entry, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value libesedb_record_t *record, int value_entry, uint8_t **value_data, size_t *value_data_size, uint8_t *value_flags, libesedb_error_t **error Ft int Fn libesedb_record_get_value_boolean libesedb_record_t *record, int value_entry, uint8_t *value_boolean, libesedb_error_t **error Ft int Fn libesedb_record_get_value_8bit libesedb_record_t *record, int value_entry, uint8_t *value_8bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_16bit libesedb_record_t *record, int value_entry, uint16_t *value_16bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_32bit libesedb_record_t *record, int value_entry, uint32_t *value_32bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_64bit libesedb_record_t *record, int value_entry, uint64_t *value_64bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_filetime libesedb_record_t *record, int value_entry, uint64_t *value_filetime, libesedb_error_t **error Ft int Fn libesedb_record_get_value_floating_point_32bit libesedb_record_t *record, int value_entry, float *value_floating_point_32bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_floating_point_64bit libesedb_record_t *record, int value_entry, double *value_floating_point_64bit, libesedb_error_t **error Ft int Fn libesedb_record_get_value_utf8_string_size libesedb_record_t *record, int value_entry, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value_utf8_string libesedb_record_t *record, int value_entry, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value_utf16_string_size libesedb_record_t *record, int value_entry, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value_utf16_string libesedb_record_t *record, int value_entry, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value_binary_data_size libesedb_record_t *record, int value_entry, size_t *binary_data_size, libesedb_error_t **error Ft int Fn libesedb_record_get_value_binary_data libesedb_record_t *record, int value_entry, uint8_t *binary_data, size_t binary_data_size, libesedb_error_t **error Ft int Fn libesedb_record_get_long_value libesedb_record_t *record, int value_entry, libesedb_long_value_t **long_value, libesedb_error_t **error Ft int Fn libesedb_record_get_multi_value libesedb_record_t *record, int value_entry, libesedb_multi_value_t **multi_value, libesedb_error_t **error

Long value functions Ft int Fn libesedb_long_value_free libesedb_long_value_t **long_value, libesedb_error_t **error Ft int Fn libesedb_long_value_get_number_of_segments libesedb_long_value_t *long_value, int *number_of_segments, libesedb_error_t **error Ft int Fn libesedb_long_value_get_segment_data libesedb_long_value_t *long_value, int data_segment_index, uint8_t **segment_data, size_t *segment_data_size, libesedb_error_t **error

Multi value functions Ft int Fn libesedb_multi_value_free libesedb_multi_value_t **multi_value, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_number_of_values libesedb_multi_value_t *multi_value, int *number_of_values, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_entry_value libesedb_multi_value_t *multi_value, int value_index, uint32_t *value_type, uint8_t **value_data, size_t *value_data_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_32bit libesedb_multi_value_t *multi_value, int value_index, uint32_t *value_32bit, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_64bit libesedb_multi_value_t *multi_value, int value_index, uint64_t *value_64bit, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_filetime libesedb_multi_value_t *multi_value, int value_index, uint64_t *value_filetime, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_utf8_string_size libesedb_multi_value_t *multi_value, int value_index, size_t *utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_utf8_string libesedb_multi_value_t *multi_value, int value_index, uint8_t *utf8_string, size_t utf8_string_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_utf16_string_size libesedb_multi_value_t *multi_value, int value_index, size_t *utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_utf16_string libesedb_multi_value_t *multi_value, int value_index, uint16_t *utf16_string, size_t utf16_string_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_binary_data_size libesedb_multi_value_t *multi_value, int value_index, size_t *binary_data_size, libesedb_error_t **error Ft int Fn libesedb_multi_value_get_value_binary_data libesedb_multi_value_t *multi_value, int value_index, uint8_t *binary_data, size_t binary_data_size, libesedb_error_t **error

DESCRIPTION

The Fn libesedb_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 refer to libesedb.h

ENVIRONMENT

None

FILES

None

NOTES

libesedb uses mainly UTF-8 encoded strings except for filenames, but provides several UTF-16 functions.

ASCII strings in an EDB file contain an extended ASCII string using the codepage of the system it was created on. The function libesedb_set_ascii_codepage
 allows to set the required codepage for reading and writing. The default codepage is ASCII and replaces all extended characters to the Unicode replacement character (U+fffd) when reading and the ASCII substitude character (0x1a) when writing.

libesedb allows to be compiled with wide character support. To compile libesedb with wide character support use ./configure --enable-wide-character-type=yes or pass the definition HAVE_WIDE_CHARACTER_TYPE
 to the compiler (i.e. in case of Microsoft Visual Studio (MSVS) C++).

To have other code to determine if libesedb was compiled with wide character support it defines LIBESEDB_HAVE_WIDE_CHARACTER_TYPE
 in libesedb/features.h.

libesedb allows to be compiled with chained IO support using libbfio. libesedb will automatically detect if a compatible version of libbfio is available.

To have other code to determine if libesedb was compiled with libbfio support it defines LIBESEDB_HAVE_BFIO
 in libesedb/features.h.

BUGS

Please report bugs of any kind to <jbmetz [at] users.sourceforge.net> or on the project website: http://libesedb.sourceforge.net/

AUTHOR

These man pages were written by Joachim Metz.

COPYRIGHT

Copyright 2009-2012 Joachim Metz <jbmetz [at] users.sourceforge.net>.

SEE ALSO

the libesedb.h include file