Provided by: libesedb-dev_20181229-3.2build1_amd64 
NAME
libesedb.h — Library to access the Extensible Storage Engine (ESE) Database File (EDB) format
LIBRARY
library “libesedb”
SYNOPSIS
#include <libesedb.h>
Support functions
const char *
libesedb_get_version(void);
int
libesedb_get_access_flags_read(void);
int
libesedb_get_codepage(int *codepage, libesedb_error_t **error);
int
libesedb_set_codepage(int codepage, libesedb_error_t **error);
int
libesedb_check_file_signature(const char *filename, libesedb_error_t **error);
Available when compiled with wide character string support:
int
libesedb_check_file_signature_wide(const wchar_t *filename, libesedb_error_t **error);
Available when compiled with libbfio support:
int
libesedb_check_file_signature_file_io_handle(libbfio_handle_t *bfio_handle, libesedb_error_t **error);
Notify functions
void
libesedb_notify_set_verbose(int verbose);
int
libesedb_notify_set_stream(FILE *stream, libesedb_error_t **error);
int
libesedb_notify_stream_open(const char *filename, libesedb_error_t **error);
int
libesedb_notify_stream_close(libesedb_error_t **error);
Error functions
void
libesedb_error_free(libesedb_error_t **error);
int
libesedb_error_fprint(libesedb_error_t *error, FILE *stream);
int
libesedb_error_sprint(libesedb_error_t *error, char *string, size_t size);
int
libesedb_error_backtrace_fprint(libesedb_error_t *error, FILE *stream);
int
libesedb_error_backtrace_sprint(libesedb_error_t *error, char *string, size_t size);
File functions
int
libesedb_file_initialize(libesedb_file_t **file, libesedb_error_t **error);
int
libesedb_file_free(libesedb_file_t **file, libesedb_error_t **error);
int
libesedb_file_signal_abort(libesedb_file_t *file, libesedb_error_t **error);
int
libesedb_file_open(libesedb_file_t*file,constchar *filename, int access_flags, libesedb_error_t **error);
int
libesedb_file_close(libesedb_file_t *file, libesedb_error_t **error);
int
libesedb_file_get_type(libesedb_file_t *file, uint32_t *type, libesedb_error_t **error);
int
libesedb_file_get_format_version(libesedb_file*_tiluei,nt32*_tormat_versiouni,nt32*_tormat_revisiloinb,esedb_erro*r*_trror);
int
libesedb_file_get_creation_format_version(libesedb_fi*lfueii_ntet*,3f2o_tmat_versuiionnt,3*2f_trmat_revisiloinb,esedb_erro*r*_trror);
int
libesedb_file_get_page_size(libesedb_file_t *file, uint32_t *page_size, libesedb_error_t **error);
int
libesedb_file_get_number_of_tables(libesedb_file_t *file, int *number_of_tables,libesedb_error_t**error);
int
libesedb_file_get_table(libesedb_file_t*file,inttable_entry,libesedb_table_t**table,libesedb_error_t**error);
int
libesedb_file_get_table_by_utf8_name(libesedb_fi*lfcueioi_nn*testu,t8t_t8_strsiiunztgef,_t_string_lenlgitbhe,sedb_tab*l*etl_itbblees,edb_er*r*oerr_tor);
int
libesedb_file_get_table_by_utf16_name(libesedb_f*ciifon*lintuels1t_t6ft,_t6_stsuritizfne1g_,t_string_lenlgitbhe,sedb_tab*l*et_ltbilbee,sedb_err*o*re_tror);
Available when compiled with wide character string support:
int
libesedb_file_open_wide(libesedb_file_t*file,constwchar_t*filename,intaccess_flags,libesedb_error_t**error);
Available when compiled with libbfio support:
int
libesedb_file_open_file_io_handle(libesedb_fil*ef_ltlieb,bfio_handle*_tile_io_handliaenc,tcess_flaglsi,besedb_error*_terror);
Table functions
int
libesedb_table_free(libesedb_table_t **table, libesedb_error_t **error);
int
libesedb_table_get_identifier(libesedb_table_t *table, uint32_t *identifier, libesedb_error_t **error);
int
libesedb_table_get_utf8_name_size(libesedb_table_t*table,size_t*utf8_string_size,libesedb_error_t**error);
int
libesedb_table_get_utf8_name(libesedb_table*_tableu,int8_tutf8_strings,ize_ttf8_string_sizel,ibesedb_error_t*error);
int
libesedb_table_get_utf16_name_size(libesedb_table_t*table,size_t*utf16_string_size,libesedb_error_t**error);
int
libesedb_table_get_utf16_name(libesedb_table*_tabluei,nt16*_ttf16_strinsgi,zeu_tf16_string_sizel,ibesedb_error_t*error);
int
libesedb_table_get_utf8_template_name_size(libesedb_table_ttables,ize_tutf8_string_sizel,ibesedb_error_t*error);
int
libesedb_table_get_utf8_template_name(libesedb_tabl*et_tbulien,t*8u_tf8_strinsgi,zeu_tf8_string_sizlei,besedb_error*_terror);
int
libesedb_table_get_utf16_template_name_size(libesedb_table_ttables,ize_tutf16_string_sizlei,besedb_error*_terror);
int
libesedb_table_get_utf16_template_name(libesedb_tabl*et_tbulien,t1*6u_tf16_strisnigzu,et_t16_string_silzieb,esedb_erro*r*_trror);
int
libesedb_table_get_number_of_columns(libesedb_table_ttablei,n*tnumber_of_columnsu,int8_tlagsl,ibesedb_error*_terror);
int
libesedb_table_get_column(libesedb_table*_tabliceno,tlumn_entrlyi,besedb_column*_tcolumuni,nt8_tlagsl,ibesedb_error_t*error);
int
libesedb_table_get_number_of_indexes(libesedb_table_t*table,int*number_of_indexes,libesedb_error_t**error);
int
libesedb_table_get_index(libesedb_table_t*table,intindex_entry,libesedb_index_t**index,libesedb_error_t**error);
int
libesedb_table_get_number_of_records(libesedb_table_t*table,int*number_of_records,libesedb_error_t**error);
int
libesedb_table_get_record(libesedb_table_ttablei,nrtecord_entryl,ibesedb_record_t**record,libesedb_error_t**error);
Column functions
int
libesedb_column_free(libesedb_column_t **column, libesedb_error_t **error);
int
libesedb_column_get_identifier(libesedb_column_t *column, uint32_t *identifier, libesedb_error_t**error);
int
libesedb_column_get_type(libesedb_column_t *column, uint32_t *type, libesedb_error_t **error);
int
libesedb_column_get_utf8_name_size(libesedb_column_t*column,size_t*utf8_string_size,libesedb_error_t**error);
int
libesedb_column_get_utf8_name(libesedb_column_tcolumnu,int8_tutf8_strinsgi,zeu_tf8_string_sizlei,besedb_error*_terror);
int
libesedb_column_get_utf16_name_size(libesedb_column_tcolumn,size_t*utf16_string_size,libesedb_error_t**error);
int
libesedb_column_get_utf16_name(libesedb_column*_tolumuni,nt16*_ttf16_strinsgi,zeu_tf16_string_sizlei,besedb_erro*r*_trror);
Index functions
int
libesedb_index_free(libesedb_index_t **index, libesedb_error_t **error);
int
libesedb_index_get_identifier(libesedb_index_t *index, uint32_t *identifier, libesedb_error_t **error);
int
libesedb_index_get_utf8_name_size(libesedb_index_t*index,size_t*utf8_string_size,libesedb_error_t**error);
int
libesedb_index_get_utf8_name(libesedb_index_tindexu,int8_tutf8_strings,ize_ttf8_string_sizel,ibesedb_error*_terror);
int
libesedb_index_get_utf16_name_size(libesedb_index_t*index,size_t*utf16_string_size,libesedb_error_t**error);
int
libesedb_index_get_utf16_name(libesedb_index_tindexu,int16*_ttf16_strinsgi,zeu_tf16_string_sizlei,besedb_error*_terror);
int
libesedb_index_get_number_of_records(libesedb_index_t*index,int*number_of_records,libesedb_error_t**error);
int
libesedb_index_get_record(libesedb_index_t*index,intrecord_entryl,ibesedb_record_t*recordl,ibesedb_error_t*error);
Record (row) functions
int
libesedb_record_free(libesedb_record_t **record, libesedb_error_t **error);
int
libesedb_record_get_number_of_values(libesedb_record_t*record,int*number_of_values,libesedb_error_t**error);
int
libesedb_record_get_column_identifier(libesedb_record*_tecorivdna,tlue_enturiyn,t3*2c_tlumn_identifileirb,esedb_erro*r*_trror);
int
libesedb_record_get_column_type(libesedb_record_trecordi,nvtalue_entryu,int32_tcolumn_typel,ibesedb_error_t**error);
int
libesedb_record_get_utf8_column_name_size(libesedb_record*_tecovriadnl,tue_entsriyz*,eu_tf8_string_silzieb,esedb_erro*r*_trror);
int
libesedb_record_get_utf8_column_name(libesedb_reco*rrvdea_iltonurted_,enutirnyt*,8u_tf8_strisnigzu,et_t8_string_silzieb,esedb_erro*r*_trror);
int
libesedb_record_get_utf16_column_name_size(libesedb_recor*dr_tcvoiarnldtu,e_entsriyz*,eu_tf16_string_silzieb,esedb_erro*r*_trror);
int
libesedb_record_get_utf16_column_name(libesedb_reco*rrvdea_iltonurted_,enutirnyt*,1u6t_t16_strsiiunztgef,_t6_string_sliizbee,sedb_erro*r*_trror);
int
libesedb_record_get_value_data_size(libesedb_record_trecordiv,natlue_entrsyi,ze*_talue_data_sizlei,besedb_error*_terror);
int
libesedb_record_get_value_data(libesedb_recor*dr_tcvoiarnldtu,e_enturiyn,t*8v_tlue_datsai,zev_tlue_data_sizlei,besedb_error*_terror);
int
libesedb_record_get_value_data_flags(libesedb_record*_tecorivdna,tlue_entruyi,nt8*_talue_data_flaglsi,besedb_erro*r*_trror);
int
libesedb_record_get_value_boolean(libesedb_record*_tecoridnv,talue_entryu,int8_tvalue_booleanl,ibesedb_error_t*error);
int
libesedb_record_get_value_8bit(libesedb_record_t*record,intvalue_entry,uint8_tvalue_8bitl,ibesedb_error_t*error);
int
libesedb_record_get_value_16bit(libesedb_record_trecordi,nvtalue_entryu,int16_tvalue_16bitl,ibesedb_error_t**error);
int
libesedb_record_get_value_32bit(libesedb_record_t*recordi,nvtalue_entryu,int32_tvalue_32bitl,ibesedb_error_t*error);
int
libesedb_record_get_value_64bit(libesedb_record_trecordi,nvtalue_entryu,int64_tvalue_64bitl,ibesedb_error_t**error);
int
libesedb_record_get_value_filetime(libesedb_record_trecordiv,natlue_entruyi,nt64*_talue_filetimlei,besedb_error*_terror);
int
libesedb_record_get_value_floating_point_32bit(libesedb_revc*aorlreiudcne_t_trefvdnla,tolrauyte,_floating_point_32lbiibte,sedb_err*o*re_tror);
int
libesedb_record_get_value_floating_point_64bit(libesedb_recvo*arrldeiu_netot_red*dnov,tuarblylu,ee_floating_point_6l4ibbiets,edb_er*r*oerr_tor);
int
libesedb_record_get_value_utf8_string_size(libesedb_recor*dr_tcvoiarnldtu,e_entsriyz*,eu_tf8_string_silzieb,esedb_error*_terror);
int
libesedb_record_get_value_utf8_string(libesedb_recor*dr_tcvoiarnldtu,e_enturiyn*,tu8t_t8_strsiiunztgef,_t_string_sliizbee,sedb_err*o*re_tror);
int
libesedb_record_get_value_utf16_string_size(libesedb_reco*rrde_vtoiarnldtu,e_entsriyz*,eu_tf16_string_silzieb,esedb_erro*r*_trror);
int
libesedb_record_get_value_utf16_string(libesedb_reco*rrvdea_iltonurted_,enutirnyt*,1u6t_t16_strsiiunztgef,_t6_string_sliizbee,sedb_err*o*re_tror);
int
libesedb_record_get_value_binary_data_size(libesedb_recor*dr_tcvoiarnldtu,e_entsriyz*,eb_tnary_data_silzieb,esedb_error*_terror);
int
libesedb_record_get_value_binary_data(libesedb_recor*dr_tcvoiarnldtu,e_enturiyn*,tb8i_tary_dsaibtziaen,_try_data_sliizbee,sedb_err*o*re_tror);
int
libesedb_record_is_long_value(libesedb_record_t *record, int value_entry, libesedb_error_t **error);
int
libesedb_record_is_multi_value(libesedb_record_t *record, int value_entry, libesedb_error_t **error);
int
libesedb_record_get_long_value(libesedb_recor*dr_tcvoiarnldtu,e_entlriyb,esedb_long_value*_tlong_valulei,besedb_error*_terror);
int
libesedb_record_get_multi_value(libesedb_recor*dr_tcvoiarnldtu,e_entlriyb,esedb_multi_valu*e*_tulti_valluieb,esedb_erro*r*_trror);
Long value functions
int
libesedb_long_value_free(libesedb_long_value_t **long_value, libesedb_error_t **error);
int
libesedb_long_value_get_data_size(libesedb_long_value_tlong_value,size64_t*data_size,libesedb_error_t**error);
int
libesedb_long_value_get_data(libesedb_long_value_t*long_value,uint8_t*datas,ize_tata_sizel,ibesedb_error_t*error);
int
libesedb_long_value_get_number_of_data_segments(libesedb_long_va*lluoen*_nt_vimanblteure_,of_data_segmleinbtess,edb_err*o*re_tror);
int
libesedb_long_value_get_data_segment_size(libesedb_long_valu*el_tng_vaaitlnaut_es,egment_insdi*ezdxea,_ta_sliizbee,sedb_err*o*re_tror);
int
libesedb_long_value_get_data_segment(libesedb_long_va*lluoend_at_viaan_ltsueeg,ment_iunidn*etdx8a,_ta_segmseidnzatet,_t_sliizbee,sedb_err*o*re_tror);
int
libesedb_long_value_get_utf8_string_size(libesedb_long_value*_tong_valusei,z*eu_tf8_string_silzieb,esedb_erro*r*_trror);
int
libesedb_long_value_get_utf8_string(libesedb_long_val*uleo_tg_vauliun*etu,8t_t8_strsiinzuget,_t8_string_silzieb,esedb_erro*r*_trror);
int
libesedb_long_value_get_utf16_string_size(libesedb_long_valu*el_tng_valsuiez*,eu_tf16_string_silzieb,esedb_erro*r*_trror);
int
libesedb_long_value_get_utf16_string(libesedb_long_va*lluoen_t_vauliunet*,1u6t_t16_strsiiunztgef,_t6_string_sliizbee,sedb_err*o*re_tror);
Multi value functions
int
libesedb_multi_value_free(libesedb_multi_value_t **multi_value, libesedb_error_t **error);
int
libesedb_multi_value_get_column_type(libesedb_multi_value_tmulti_valueu,int32*_tolumn_typlei,besedb_error*_terror);
int
libesedb_multi_value_get_number_of_values(libesedb_multi_valu*em_tlti_va*linunuetm,ber_of_valuelsi,besedb_error*_terror);
int
libesedb_multi_value_get_value_data_size(libesedb_multi_valu*em_tlti_vaaillnuutee_,ensti*rzvyea,_tue_data_sliizbee,sedb_err*o*re_tror);
int
libesedb_multi_value_get_value_data(libesedb_multi_va*lmuuel_tiv_vilanulteu_ee,nutirn*ytv,8a_tue_dsaivtzaael,_te_data_sliizbee,sedb_err*o*re_tror);
int
libesedb_multi_value_get_value_8bit(libesedb_multi_valu*em_tlti_vamliuunlett,i_value_indueixn*,tv8a_tue_8lbiibte,sedb_err*o*re_tror);
int
libesedb_multi_value_get_value_16bit(libesedb_multi_val*umeu_tti_vuaillntutie_,value_inudienxt*,1v6a_tue_16lbiibte,sedb_erro*r*_trror);
int
libesedb_multi_value_get_value_32bit(libesedb_multi_valu*em_tlti_vuaillntutie_,value_inudienxt*,3v2a_tue_32lbiibte,sedb_err*o*re_tror);
int
libesedb_multi_value_get_value_64bit(libesedb_multi_val*umeu_tti_vuaillntutie_,value_inudienxt*,6v4a_tue_64lbiibte,sedb_erro*r*_trror);
int
libesedb_multi_value_get_value_floating_point_32bit(libesedb_multi_va*lmuuel_mtiu_vitanilt_uvea,lu*ev_aillnoudaeet_x3i,2bbeiste,db_e*r*reorrr_tr);
int
libesedb_multi_value_get_value_floating_point_64bit(libesedb_multi_v*amlumuluetl_tt_ivn_atvlauleu,e*_vioanuldbuelexe_,6l4ibbiets,edb_er*r*oerr_tor);
int
libesedb_multi_value_get_value_filetime(libesedb_multi_val*umeu_ttim_vlaitlniut_ev,alue_iunidn*etvx6a,4l_te_fileltiibmees,edb_er*r*oerr_tor);
int
libesedb_multi_value_get_value_utf8_string_size(libesedb_multi_v*amlumuluetl_tt_ivn_atvlauleu,e*_uiitnzfde8e_xts,tringl_sbiezsee,db_er*r*oerr_tor);
int
libesedb_multi_value_get_value_utf8_string(libesedb_multi_va*lmuumelu_ltit_ivn_atvlauleu,e_*iiunntdtfe88x_,tssttifrz8ie_n_gtt,ringl_sbiezsee,db_e*r*reorrr_tr);
int
libesedb_multi_value_get_value_utf16_string_size(libesedb_multi_vmaumlluutleit_itvn_atvlauleu,e*_uiitnzfde1e_xt_,stringl_sbiezsee,db_e*r*reorrr_tr);
int
libesedb_multi_value_get_value_utf16_string(libesedb_multi_v*amlumuluetl_tt_ivn_atvlauleu,e_ii*nnudtte1fx61,_ut_ssfti1rz6ie_n_gtt,rinlgi_seiszeed,b_e*rerrorro_tint
libesedb_multi_value_get_value_binary_data_size(libesedb_multi_v*amlumuluetl_tt_ivn_atvlauleu,e*_biiinzndeae_xty,_datal_sbiezsee,db_er*r*oerr_tor);
int
libesedb_multi_value_get_value_binary_data(libesedb_multi_va*lmuumelu_ltit_ivn_atvlauleu,e_*iibnnidtne8ax_b,tysi_ndzaaert_at_,datal_sbiezsee,db_e*r*reorrr_tr);
DESCRIPTION
The 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 see "libesedb.h".
ENVIRONMENT
None
FILES
None
NOTES
libesedb allows to 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.
BUGS
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libesedb/issues
AUTHOR
These man pages are generated from "libesedb.h".
COPYRIGHT
Copyright (C) 2009-2018, 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 libesedb.h include file
libesedb January 21, 2017 libesedb(3)