logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Contents

Author

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

Bugs

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

Description

       The libesedb_get_version() function is used to retrieve the library version.

Environment

       None

Files

       None

Name

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

Notes

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

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

       LIBESEDB_WIDE_CHARACTER_TYPE
        in libesedb/features.h can be used to determine if libesedb was compiled with wide character support.

Return Values

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

See Also

       the libesedb.h include file

libesedb                                          April 1, 2019                                      libesedb(3)

Synopsis

#include<libesedb.h>

       Support functions

       constchar*libesedb_get_version(void);

       intlibesedb_get_access_flags_read(void);

       intlibesedb_get_codepage(int*codepage, libesedb_error_t**error);

       intlibesedb_set_codepage(intcodepage, libesedb_error_t**error);

       intlibesedb_check_file_signature(constchar*filename, libesedb_error_t**error);

       Available when compiled with wide character string support:

       intlibesedb_check_file_signature_wide(constwchar_t*filename, libesedb_error_t**error);

       Available when compiled with libbfio support:

       intlibesedb_check_file_signature_file_io_handle(libbfio_handle_t*bfio_handle, libesedb_error_t**error);

       Notify functions

       voidlibesedb_notify_set_verbose(intverbose);

       intlibesedb_notify_set_stream(FILE*stream, libesedb_error_t**error);

       intlibesedb_notify_stream_open(constchar*filename, libesedb_error_t**error);

       intlibesedb_notify_stream_close(libesedb_error_t**error);

       Error functions

       voidlibesedb_error_free(libesedb_error_t**error);

       intlibesedb_error_fprint(libesedb_error_t*error, FILE*stream);

       intlibesedb_error_sprint(libesedb_error_t*error, char*string, size_tsize);

       intlibesedb_error_backtrace_fprint(libesedb_error_t*error, FILE*stream);

       intlibesedb_error_backtrace_sprint(libesedb_error_t*error, char*string, size_tsize);

       File functions

       intlibesedb_file_initialize(libesedb_file_t**file, libesedb_error_t**error);

       intlibesedb_file_free(libesedb_file_t**file, libesedb_error_t**error);

       intlibesedb_file_signal_abort(libesedb_file_t*file, libesedb_error_t**error);

       intlibesedb_file_open(libesedb_file_t*file,     constchar*filename,     intaccess_flags,
           libesedb_error_t**error);

       intlibesedb_file_close(libesedb_file_t*file, libesedb_error_t**error);

       intlibesedb_file_get_type(libesedb_file_t*file, uint32_t*type, libesedb_error_t**error);

       intlibesedb_file_get_format_version(libesedb_file_t*file,         uint32_t*format_version,
           uint32_t*format_revision, libesedb_error_t**error);

       intlibesedb_file_get_creation_format_version(libesedb_file_t*file,      uint32_t*format_version,
           uint32_t*format_revision, libesedb_error_t**error);

       intlibesedb_file_get_page_size(libesedb_file_t*file, uint32_t*page_size, libesedb_error_t**error);

       intlibesedb_file_get_number_of_tables(libesedb_file_t*file,         int*number_of_tables,
           libesedb_error_t**error);

       intlibesedb_file_get_table(libesedb_file_t*file,    inttable_entry,    libesedb_table_t**table,
           libesedb_error_t**error);

       intlibesedb_file_get_table_by_utf8_name(libesedb_file_t*file,     constuint8_t*utf8_string,
           size_tutf8_string_length, libesedb_table_t**table, libesedb_error_t**error);

       intlibesedb_file_get_table_by_utf16_name(libesedb_file_t*file,     constuint16_t*utf16_string,
           size_tutf16_string_length, libesedb_table_t**table, libesedb_error_t**error);

       Available when compiled with wide character string support:

       intlibesedb_file_open_wide(libesedb_file_t*file,   constwchar_t*filename,    intaccess_flags,
           libesedb_error_t**error);

       Available when compiled with libbfio support:

       intlibesedb_file_open_file_io_handle(libesedb_file_t*file,      libbfio_handle_t*file_io_handle,
           intaccess_flags, libesedb_error_t**error);

       Table functions

       intlibesedb_table_free(libesedb_table_t**table, libesedb_error_t**error);

       intlibesedb_table_get_identifier(libesedb_table_t*table, uint32_t*identifier, libesedb_error_t**error);

       intlibesedb_table_get_utf8_name_size(libesedb_table_t*table,        size_t*utf8_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf8_name(libesedb_table_t*table,  uint8_t*utf8_string,  size_tutf8_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf16_name_size(libesedb_table_t*table,       size_t*utf16_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf16_name(libesedb_table_t*table, uint16_t*utf16_string, size_tutf16_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf8_template_name_size(libesedb_table_t*table,     size_t*utf8_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf8_template_name(libesedb_table_t*table,        uint8_t*utf8_string,
           size_tutf8_string_size, libesedb_error_t**error);

       intlibesedb_table_get_utf16_template_name_size(libesedb_table_t*table,    size_t*utf16_string_size,
           libesedb_error_t**error);

       intlibesedb_table_get_utf16_template_name(libesedb_table_t*table,       uint16_t*utf16_string,
           size_tutf16_string_size, libesedb_error_t**error);

       intlibesedb_table_get_number_of_columns(libesedb_table_t*table,  int*number_of_columns,  uint8_tflags,
           libesedb_error_t**error);

       intlibesedb_table_get_column(libesedb_table_t*table,   intcolumn_entry,   libesedb_column_t**column,
           uint8_tflags, libesedb_error_t**error);

       intlibesedb_table_get_number_of_indexes(libesedb_table_t*table,        int*number_of_indexes,
           libesedb_error_t**error);

       intlibesedb_table_get_index(libesedb_table_t*table,    intindex_entry,   libesedb_index_t**index,
           libesedb_error_t**error);

       intlibesedb_table_get_number_of_records(libesedb_table_t*table,        int*number_of_records,
           libesedb_error_t**error);

       intlibesedb_table_get_record(libesedb_table_t*table,   intrecord_entry,   libesedb_record_t**record,
           libesedb_error_t**error);

       Column functions

       intlibesedb_column_free(libesedb_column_t**column, libesedb_error_t**error);

       intlibesedb_column_get_identifier(libesedb_column_t*column,          uint32_t*identifier,
           libesedb_error_t**error);

       intlibesedb_column_get_type(libesedb_column_t*column, uint32_t*type, libesedb_error_t**error);

       intlibesedb_column_get_utf8_name_size(libesedb_column_t*column,       size_t*utf8_string_size,
           libesedb_error_t**error);

       intlibesedb_column_get_utf8_name(libesedb_column_t*column, uint8_t*utf8_string,  size_tutf8_string_size,
           libesedb_error_t**error);

       intlibesedb_column_get_utf16_name_size(libesedb_column_t*column,      size_t*utf16_string_size,
           libesedb_error_t**error);

       intlibesedb_column_get_utf16_name(libesedb_column_t*column,         uint16_t*utf16_string,
           size_tutf16_string_size, libesedb_error_t**error);

       Index functions

       intlibesedb_index_free(libesedb_index_t**index, libesedb_error_t**error);

       intlibesedb_index_get_identifier(libesedb_index_t*index, uint32_t*identifier, libesedb_error_t**error);

       intlibesedb_index_get_utf8_name_size(libesedb_index_t*index,        size_t*utf8_string_size,
           libesedb_error_t**error);

       intlibesedb_index_get_utf8_name(libesedb_index_t*index,  uint8_t*utf8_string,  size_tutf8_string_size,
           libesedb_error_t**error);

       intlibesedb_index_get_utf16_name_size(libesedb_index_t*index,       size_t*utf16_string_size,
           libesedb_error_t**error);

       intlibesedb_index_get_utf16_name(libesedb_index_t*index, uint16_t*utf16_string, size_tutf16_string_size,
           libesedb_error_t**error);

       intlibesedb_index_get_number_of_records(libesedb_index_t*index,        int*number_of_records,
           libesedb_error_t**error);

       intlibesedb_index_get_record(libesedb_index_t*index,   intrecord_entry,   libesedb_record_t**record,
           libesedb_error_t**error);

       Record (row) functions

       intlibesedb_record_free(libesedb_record_t**record, libesedb_error_t**error);

       intlibesedb_record_get_number_of_values(libesedb_record_t*record,       int*number_of_values,
           libesedb_error_t**error);

       intlibesedb_record_get_column_identifier(libesedb_record_t*record,         intvalue_entry,
           uint32_t*column_identifier, libesedb_error_t**error);

       intlibesedb_record_get_column_type(libesedb_record_t*record,   intvalue_entry,  uint32_t*column_type,
           libesedb_error_t**error);

       intlibesedb_record_get_utf8_column_name_size(libesedb_record_t*record,        intvalue_entry,
           size_t*utf8_string_size, libesedb_error_t**error);

       intlibesedb_record_get_utf8_column_name(libesedb_record_t*record,  intvalue_entry, uint8_t*utf8_string,
           size_tutf8_string_size, libesedb_error_t**error);

       intlibesedb_record_get_utf16_column_name_size(libesedb_record_t*record,       intvalue_entry,
           size_t*utf16_string_size, libesedb_error_t**error);

       intlibesedb_record_get_utf16_column_name(libesedb_record_t*record, intvalue_entry, uint16_t*utf16_string,
           size_tutf16_string_size, libesedb_error_t**error);

       intlibesedb_record_get_value_data_size(libesedb_record_t*record, intvalue_entry, size_t*value_data_size,
           libesedb_error_t**error);

       intlibesedb_record_get_value_data(libesedb_record_t*record,   intvalue_entry,   uint8_t*value_data,
           size_tvalue_data_size, libesedb_error_t**error);

       intlibesedb_record_get_value_data_flags(libesedb_record_t*record,         intvalue_entry,
           uint8_t*value_data_flags, libesedb_error_t**error);

       intlibesedb_record_get_value_boolean(libesedb_record_t*record,  intvalue_entry,  uint8_t*value_boolean,
           libesedb_error_t**error);

       intlibesedb_record_get_value_8bit(libesedb_record_t*record,   intvalue_entry,   uint8_t*value_8bit,
           libesedb_error_t**error);

       intlibesedb_record_get_value_16bit(libesedb_record_t*record,  intvalue_entry,   uint16_t*value_16bit,
           libesedb_error_t**error);

       intlibesedb_record_get_value_32bit(libesedb_record_t*record,   intvalue_entry,  uint32_t*value_32bit,
           libesedb_error_t**error);

       intlibesedb_record_get_value_64bit(libesedb_record_t*record,  intvalue_entry,   uint64_t*value_64bit,
           libesedb_error_t**error);

       intlibesedb_record_get_value_filetime(libesedb_record_t*record, intvalue_entry, uint64_t*value_filetime,
           libesedb_error_t**error);

       intlibesedb_record_get_value_floating_point_32bit(libesedb_record_t*record,      intvalue_entry,
           float*value_floating_point_32bit, libesedb_error_t**error);

       intlibesedb_record_get_value_floating_point_64bit(libesedb_record_t*record,      intvalue_entry,
           double*value_floating_point_64bit, libesedb_error_t**error);

       intlibesedb_record_get_value_utf8_string_size(libesedb_record_t*record,       intvalue_entry,
           size_t*utf8_string_size, libesedb_error_t**error);

       intlibesedb_record_get_value_utf8_string(libesedb_record_t*record,  intvalue_entry, uint8_t*utf8_string,
           size_tutf8_string_size, libesedb_error_t**error);

       intlibesedb_record_get_value_utf16_string_size(libesedb_record_t*record,       intvalue_entry,
           size_t*utf16_string_size, libesedb_error_t**error);

       intlibesedb_record_get_value_utf16_string(libesedb_record_t*record,         intvalue_entry,
           uint16_t*utf16_string, size_tutf16_string_size, libesedb_error_t**error);

       intlibesedb_record_get_value_binary_data_size(libesedb_record_t*record,       intvalue_entry,
           size_t*binary_data_size, libesedb_error_t**error);

       intlibesedb_record_get_value_binary_data(libesedb_record_t*record,  intvalue_entry, uint8_t*binary_data,
           size_tbinary_data_size, libesedb_error_t**error);

       intlibesedb_record_is_long_value(libesedb_record_t*record, intvalue_entry, libesedb_error_t**error);

       intlibesedb_record_is_multi_value(libesedb_record_t*record, intvalue_entry, libesedb_error_t**error);

       intlibesedb_record_get_long_value(libesedb_record_t*record,           intvalue_entry,
           libesedb_long_value_t**long_value, libesedb_error_t**error);

       intlibesedb_record_get_multi_value(libesedb_record_t*record,           intvalue_entry,
           libesedb_multi_value_t**multi_value, libesedb_error_t**error);

       Long value functions

       intlibesedb_long_value_free(libesedb_long_value_t**long_value, libesedb_error_t**error);

       intlibesedb_long_value_get_data_size(libesedb_long_value_t*long_value,      size64_t*data_size,
           libesedb_error_t**error);

       intlibesedb_long_value_get_data(libesedb_long_value_t*long_value,   uint8_t*data,   size_tdata_size,
           libesedb_error_t**error);

       intlibesedb_long_value_get_number_of_data_segments(libesedb_long_value_t*long_value,
           int*number_of_data_segments, libesedb_error_t**error);

       intlibesedb_long_value_get_data_segment_size(libesedb_long_value_t*long_value,   intdata_segment_index,
           size_t*data_size, libesedb_error_t**error);

       intlibesedb_long_value_get_data_segment(libesedb_long_value_t*long_value,    intdata_segment_index,
           uint8_t*data_segment, size_tdata_size, libesedb_error_t**error);

       intlibesedb_long_value_get_utf8_string_size(libesedb_long_value_t*long_value,  size_t*utf8_string_size,
           libesedb_error_t**error);

       intlibesedb_long_value_get_utf8_string(libesedb_long_value_t*long_value,     uint8_t*utf8_string,
           size_tutf8_string_size, libesedb_error_t**error);

       intlibesedb_long_value_get_utf16_string_size(libesedb_long_value_t*long_value,  size_t*utf16_string_size,
           libesedb_error_t**error);

       intlibesedb_long_value_get_utf16_string(libesedb_long_value_t*long_value,    uint16_t*utf16_string,
           size_tutf16_string_size, libesedb_error_t**error);

       Multi value functions

       intlibesedb_multi_value_free(libesedb_multi_value_t**multi_value, libesedb_error_t**error);

       intlibesedb_multi_value_get_column_type(libesedb_multi_value_t*multi_value,    uint32_t*column_type,
           libesedb_error_t**error);

       intlibesedb_multi_value_get_number_of_values(libesedb_multi_value_t*multi_value,  int*number_of_values,
           libesedb_error_t**error);

       intlibesedb_multi_value_get_value_data_size(libesedb_multi_value_t*multi_value,     intvalue_entry,
           size_t*value_data_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_data(libesedb_multi_value_t*multi_value,      intvalue_entry,
           uint8_t*value_data, size_tvalue_data_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_8bit(libesedb_multi_value_t*multi_value,    intmulti_value_index,
           uint8_t*value_8bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_16bit(libesedb_multi_value_t*multi_value,    intmulti_value_index,
           uint16_t*value_16bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_32bit(libesedb_multi_value_t*multi_value,    intmulti_value_index,
           uint32_t*value_32bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_64bit(libesedb_multi_value_t*multi_value,    intmulti_value_index,
           uint64_t*value_64bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_floating_point_32bit(libesedb_multi_value_t*multi_value,
           intmulti_value_index, float*value_32bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_floating_point_64bit(libesedb_multi_value_t*multi_value,
           intmulti_value_index, double*value_64bit, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_filetime(libesedb_multi_value_t*multi_value,   intmulti_value_index,
           uint64_t*value_filetime, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_utf8_string_size(libesedb_multi_value_t*multi_value,
           intmulti_value_index, size_t*utf8_string_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_utf8_string(libesedb_multi_value_t*multi_value,  intmulti_value_index,
           uint8_t*utf8_string, size_tutf8_string_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_utf16_string_size(libesedb_multi_value_t*multi_value,
           intmulti_value_index, size_t*utf16_string_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_utf16_string(libesedb_multi_value_t*multi_value,  intmulti_value_index,
           uint16_t*utf16_string, size_tutf16_string_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_binary_data_size(libesedb_multi_value_t*multi_value,
           intmulti_value_index, size_t*binary_data_size, libesedb_error_t**error);

       intlibesedb_multi_value_get_value_binary_data(libesedb_multi_value_t*multi_value,  intmulti_value_index,
           uint8_t*binary_data, size_tbinary_data_size, libesedb_error_t**error);

See Also

String
String PNG Icons
Man Pages
multi Man Pages
← View Library functions Category← Back to String manipulation🙏  Credits & Acknowledgments