libbfio.h — Library to support (abstracted) basic file input/output (IO)

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

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

       Copyright (C) 2009-2017, 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.

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

       None

       None

       library “libbfio”

       libbfio.h — Library to support (abstracted) basic file input/output (IO)

       libbfio allows to be compiled with wide character support (wchar_t).

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

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

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

       the libbfio.h include file

libbfio                                         January 23, 2017                                      libbfio(3)

#include<libbfio.h>

       Support functions

       constchar*libbfio_get_version(void);

       intlibbfio_get_codepage(int*codepage,libbfio_error_t**error);

       intlibbfio_set_codepage(intcodepage,libbfio_error_t**error);

       Error functions

       voidlibbfio_error_free(libbfio_error_t**error);

       intlibbfio_error_fprint(libbfio_error_t*error,FILE*stream);

       intlibbfio_error_sprint(libbfio_error_t*error,char*string,size_tsize);

       intlibbfio_error_backtrace_fprint(libbfio_error_t*error,FILE*stream);

       intlibbfio_error_backtrace_sprint(libbfio_error_t*error,char*string,size_tsize);

       Handle functions

       intlibbfio_handle_initialize(libbfio_h**a*i*fnhnirdatoelnp_eedthn__ratite_o,td_lhi**ean*c,ntildpoolt_inerhine)_bt_(tnbidfoli_eo)hi*,_,an*e*ntdredperrltsorertro)__(tntat(i*oein(xn*_o*itiiifslispoobfewintt__*sb6ehbtsrhl*hnsif4keb)_iiato(*szi_f(tnbsnpua(ls*i*ubieo)toi*cidbi_dtrc*i*iswniiuz,_,fniieo)lfnon*lrc(i*ccnibirtonfee*ftoon,_,eitptie_*nielto(i*sbzip_tf_esp_fte*,oepo,t_tosop_s*niifettho8etrrethffre_t_ipp_slisthisrto*szi_ran_ortrafsrre*))rhl*oethn_nerabiep_bieo)t)_st,ro)_6eorr*,(_ig_inratfbt)_bzathiuz,_,(tdt_(td4troretnbehin)_lb(tdfedranfee*ltl__ordbitabt(tdafli__tf_eeettrrlfn_nblgieo)t(td8etrr,,_eitsn*dfeso),_,l_ortr,oitili,,_,e*et,ro_poeo)e*re,_e*)et_,_,rerrtr*,)rhsle*rrorre(_i*ireorroortnzsblrrro_rrdeibufior_t_l6zfilbrottre4einab_,_otgftt_sie*)_or*,t_ree*orr*rrre_ortrrr_tr);

       intlibbfio_handle_free(libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_handle_clone(libbfio_handle_t**destination_handle,libbfio_handle_tsource_handlel,ibbfio_error_t*error);

       intlibbfio_handle_open(libbfio_handle_t*handle,intaccess_flags,libbfio_error_t**error);

       intlibbfio_handle_reopen(libbfio_handle_t*handle,intaccess_flags,libbfio_error_t**error);

       intlibbfio_handle_close(libbfio_handle_t*handle,libbfio_error_t**error);

       ssize_tlibbfio_handle_read_buffer(libbfio_handle_t*handle,uint8_t*buffer,size_tsize,libbfio_error_t**error);

       ssize_tlibbfio_handle_write_buffer(libbfio_handle_t*handle,constuint8_t*buffer,size_tsize,libbfio_error_t**error);

       off64_tlibbfio_handle_seek_offset(libbfio_handle_t*handle,off64_toffset,intwhence,libbfio_error_t**error);

       intlibbfio_handle_exists(libbfio_handle_t*handle,libbfio_error_t**error);

       intlibbfio_handle_is_open(libbfio_handle_t*handle,libbfio_error_t**error);

       intlibbfio_handle_get_io_handle(libbfio_handle_t*handle,intptr_t**io_handle,libbfio_error_t**error);

       intlibbfio_handle_get_access_flags(libbfio_handle_t*handle,int*access_flags,libbfio_error_t**error);

       intlibbfio_handle_set_access_flags(libbfio_handle_t*handle,intaccess_flags,libbfio_error_t**error);

       intlibbfio_handle_get_size(libbfio_handle_t*handle,size64_t*size,libbfio_error_t**error);

       intlibbfio_handle_set_open_on_demand(libbfio_handle_t*handle,uint8_topen_on_demand,libbfio_error_t**error);

       intlibbfio_handle_set_track_offsets_read(libbfio_handle_thandleu,int8_ttrack_offsets_read,libbfio_error_t**error);

       intlibbfio_handle_get_offset(libbfio_handle_t*handle,off64_t*offset,libbfio_error_t**error);

       intlibbfio_handle_get_number_of_offsets_read(libbfio_handle_thandlei,n*tnumber_of_read_offsetlsi,bbfio_error*_terror);

       intlibbfio_handle_get_offset_read(libbfio_handle_thandlei,nitndex,off64_t*offset,size64_t*size,libbfio_error_t**error);

       File functions

       intlibbfio_file_initialize(libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_file_get_name_size(libbfio_handle_t*handle,size_t*name_size,libbfio_error_t**error);

       intlibbfio_file_get_name(libbfio_handle_t*handle,char*name,size_tname_size,libbfio_error_t**error);

       intlibbfio_file_set_name(libbfio_handle_t*handle,constchar*name,size_tname_length,libbfio_error_t**error);

       Available when compiled with wide character string support:

       intlibbfio_file_get_name_size_wide(libbfio_handle_t*handle,size_t*name_size,libbfio_error_t**error);

       intlibbfio_file_get_name_wide(libbfio_handle_t*handle,wchar_t*name,size_tname_size,libbfio_error_t**error);

       intlibbfio_file_set_name_wide(libbfio_handle_t*handle,constwchar_t*name,size_tname_length,libbfio_error_t**error);

       File range functions

       intlibbfio_file_range_initialize(libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_file_range_get_name_size(libbfio_handle_t*handle,size_t*name_size,libbfio_error_t**error);

       intlibbfio_file_range_get_name(libbfio_handle_t*handle,char*name,size_tname_size,libbfio_error_t**error);

       intlibbfio_file_range_set_name(libbfio_handle_t*handle,constchar*name,size_tname_length,libbfio_error_t**error);

       intlibbfio_file_range_get(libbfio_handle_t*handle,off64_t*range_offset,size64_t*range_size,libbfio_error_t**error);

       intlibbfio_file_range_set(libbfio_handle_t*handle,off64_trange_offset,size64_trange_size,libbfio_error_t**error);

       Available when compiled with wide character string support:

       intlibbfio_file_range_get_name_size_wide(libbfio_handle_t*handle,size_t*name_size,libbfio_error_t**error);

       intlibbfio_file_range_get_name_wide(libbfio_handle_t*handle,wchar_t*name,size_tname_size,libbfio_error_t**error);

       intlibbfio_file_range_set_name_wide(libbfio_handle_thandlec,onswtchar_tname,size_tname_length,libbfio_error_t**error);

       Memory range functions

       intlibbfio_memory_range_initialize(libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_memory_range_get(libbfio_handle_t*handle,uint8_t**start,size_t*size,libbfio_error_t**error);

       intlibbfio_memory_range_set(libbfio_handle_t*handle,uint8_t*start,size_tsize,libbfio_error_t**error);

       Pool functions

       intlibbfio_pool_initialize(libbfio_pool*_tpooinlnu,tmber_of_handleimsna,tximum_number_of_open_handlesl,ibbfio_error_t*error);

       intlibbfio_pool_free(libbfio_pool_t**pool,libbfio_error_t**error);

       intlibbfio_pool_clone(libbfio_pool_t**destination_pool,libbfio_pool_t*source_pool,libbfio_error_t**error);

       intlibbfio_pool_resize(libbfio_pool_t*pool,intnumber_of_handles,libbfio_error_t**error);

       intlibbfio_pool_get_number_of_handles(libbfio_pool_t*pool,int*number_of_handles,libbfio_error_t**error);

       intlibbfio_pool_get_handle(libbfio_pool_t*pool,intentry,libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_pool_append_handle(libbfio_pool_tpooli,n*tentryl,ibbfio_handle_thandlei,natccess_flags,libbfio_error_t**error);

       intlibbfio_pool_set_handle(libbfio_pool_t*pool,intentry,libbfio_handle_t*handle,inatccess_flagsl,ibbfio_error_t*error);

       intlibbfio_pool_remove_handle(libbfio_pool_t*pool,intentry,libbfio_handle_t**handle,libbfio_error_t**error);

       intlibbfio_pool_get_maximum_number_of_open_handles(libbfio_poo*lp*_imtonaltx,imum_number_of_open_handlliebsb,fio_err*o*re_tror);

       intlibbfio_pool_set_maximum_number_of_open_handles(libbfio_po*opmloia_nxtlti,mum_number_of_open_handlleisb,bfio_erro*r*_trror);

       intlibbfio_pool_open(libbfio_pool_t*pool,intentry,intaccess_flags,libbfio_error_t**error);

       intlibbfio_pool_reopen(libbfio_pool_t*pool,intentry,intaccess_flags,libbfio_error_t**error);

       intlibbfio_pool_close(libbfio_pool_t*pool,intentry,libbfio_error_t**error);

       intlibbfio_pool_close_all(libbfio_pool_t*pool,libbfio_error_t**error);

       ssize_tlibbfio_pool_read_buffer(libbfio_pool_t*pool,intentry,uint8_t*buffer,size_tsize,libbfio_error_t**error);

       ssize_tlibbfio_pool_write_buffer(libbfio_pool_t*pool,intentry,constuint8_t*buffer,size_tsize,libbfio_error_t**error);

       off64_tlibbfio_pool_seek_offset(libbfio_pool_t*pool,intentry,off64_toffset,intwhence,libbfio_error_t**error);

       intlibbfio_pool_get_offset(libbfio_pool_t*pool,intentry,off64_t*offset,libbfio_error_t**error);

       intlibbfio_pool_get_size(libbfio_pool_t*pool,intentry,size64_t*size,libbfio_error_t**error);

       File pool functions

       intlibbfio_file_pool_append_handles_for_names(libbfio_poo*lpc_cotoh*nnlasa,rtmes[in]nu,tmber_of_nameiasnc,tcess_flaglsi,bbfio_error*_terror);

       Available when compiled with wide character string support:

       intlibbfio_file_pool_append_handle_for_names_wide(libbfio_pool*_toowclcon,hnaa*smrten_iut[nm]tb,er_of_naamicencste,ss_flalgisb,bfio_erro*r*_trror);