Provided by: libfsapfs-dev_20190210-1.1_amd64 
NAME
libfsapfs.h — Library to access the Apple File System (APFS) format
LIBRARY
library “libfsapfs”
SYNOPSIS
#include <libfsapfs.h>
Support functions
const char *
libfsapfs_get_version(void);
int
libfsapfs_get_access_flags_read(void);
int
libfsapfs_get_codepage(int *codepage, libfsapfs_error_t **error);
int
libfsapfs_set_codepage(int codepage, libfsapfs_error_t **error);
int
libfsapfs_check_container_signature(const char *filename, libfsapfs_error_t **error);
int
libfsapfs_check_volume_signature(const char *filename, libfsapfs_error_t **error);
Available when compiled with wide character string support:
int
libfsapfs_check_container_signature_wide(const wchar_t *filename, libfsapfs_error_t **error);
int
libfsapfs_check_volume_signature_wide(const wchar_t *filename, libfsapfs_error_t **error);
Available when compiled with libbfio support:
int
libfsapfs_check_container_signature_file_io_handle(libbfio_handle_tfile_io_handle,libfsapfs_error_t**error);
int
libfsapfs_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,libfsapfs_error_t**error);
Notify functions
void
libfsapfs_notify_set_verbose(int verbose);
int
libfsapfs_notify_set_stream(FILE *stream, libfsapfs_error_t **error);
int
libfsapfs_notify_stream_open(const char *filename, libfsapfs_error_t **error);
int
libfsapfs_notify_stream_close(libfsapfs_error_t **error);
Error functions
void
libfsapfs_error_free(libfsapfs_error_t **error);
int
libfsapfs_error_fprint(libfsapfs_error_t *error, FILE *stream);
int
libfsapfs_error_sprint(libfsapfs_error_t *error, char *string, size_t size);
int
libfsapfs_error_backtrace_fprint(libfsapfs_error_t *error, FILE *stream);
int
libfsapfs_error_backtrace_sprint(libfsapfs_error_t *error, char *string, size_t size);
Container functions
int
libfsapfs_container_initialize(libfsapfs_container_t **container, libfsapfs_error_t **error);
int
libfsapfs_container_free(libfsapfs_container_t **container, libfsapfs_error_t **error);
int
libfsapfs_container_signal_abort(libfsapfs_container_t *container, libfsapfs_error_t **error);
int
libfsapfs_container_open(libfsapfs_container_tcontainerc,onsctha*rfilenamei,ntaccess_flags,libfsapfs_error_t**error);
int
libfsapfs_container_close(libfsapfs_container_t *container, libfsapfs_error_t **error);
int
libfsapfs_container_get_size(libfsapfs_container_t *container, size64_t *size, libfsapfs_error_t**error);
int
libfsapfs_container_get_identifier(libfsapfs_containe*rc_tntainueirn,t*8u_tid_dastiazu,eu_td_data_silzieb,fsapfs_error*_terror);
int
libfsapfs_container_get_number_of_volumes(libfsapfs_container*_tontainei*rnn,tumber_of_volumleisb,fsapfs_erro*r*_trror);
int
libfsapfs_container_get_volume_by_index(libfsapfs_contai*nceorn_vtaoiilnnuetmre,_inldiebxf,sapfs_volu*m*ev_tlluimbef,sapfs_err*o*re_tror);
Available when compiled with wide character string support:
int
libfsapfs_container_open_wide(libfsapfs_container_tcontainerc,onswtchar*_tilenamiaenc,tcess_flaglsi,bfsapfs_error*_terror);
Available when compiled with libbfio support:
int
libfsapfs_container_open_file_io_handle(libfsapfs_contai*nceorn_taliinbebrf,io_han*dfliel_t_ioa_hcaiennsdtsl_efl,liabgfss,apfs_err*o*re_tror);
Volume functions
int
libfsapfs_volume_free(libfsapfs_volume_t **volume, libfsapfs_error_t **error);
int
libfsapfs_volume_signal_abort(libfsapfs_volume_t *volume, libfsapfs_error_t **error);
int
libfsapfs_volume_open(libfsapfs_volume_t*volume,constchar*filename,intaccess_flags,libfsapfs_error_t**error);
int
libfsapfs_volume_close(libfsapfs_volume_t *volume, libfsapfs_error_t **error);
int
libfsapfs_volume_unlock(libfsapfs_volume_t *volume, libfsapfs_error_t **error);
int
libfsapfs_volume_get_size(libfsapfs_volume_t *volume, size64_t *size, libfsapfs_error_t **error);
int
libfsapfs_volume_get_identifier(libfsapfs_volume*_tolumuei,nt8*_tuid_datsai,ze_tuid_data_sizel,ibfsapfs_error_t*error);
int
libfsapfs_volume_get_utf8_name_size(libfsapfs_volume_t*volume,size_t*utf8_string_sizel,ibfsapfs_error_t*error);
int
libfsapfs_volume_get_utf8_name(libfsapfs_volume*_tolumuei,nt8*_ttf8_strinsgi,zeu_tf8_string_sizlei,bfsapfs_error*_terror);
int
libfsapfs_volume_get_utf16_name_size(libfsapfs_volume_t*volumes,ize_tutf16_string_sizel,ibfsapfs_error_t*error);
int
libfsapfs_volume_get_utf16_name(libfsapfs_volum*ev_tluumien,t1*6u_tf16_strisnigz,eu_tf16_string_sizlei,bfsapfs_error*_terror);
int
libfsapfs_volume_is_locked(libfsapfs_volume_t *volume, libfsapfs_error_t **error);
int
libfsapfs_volume_set_utf8_password(libfsapfs_volum*ev_tlucmoueni,sntt*8u_tf8_strisnigzu,et_t8_string_lengltihb,fsapfs_erro*r*_trror);
int
libfsapfs_volume_set_utf16_password(libfsapfs_volu*mveo_cutuoimnnest*,t1u6t_t16_strisnigzu,et_t16_string_lengltihb,fsapfs_erro*r*_trror);
int
libfsapfs_volume_set_utf8_recovery_password(libfsapfs_volu*mveo_cutuoimnn*estu,t8t_t8_strsiiunztgef,_t_string_lenlgitbhf,sapfs_er*r*oerr_tor);
int
libfsapfs_volume_set_utf16_recovery_password(libfsapfs_vol*uvumocielon*_ntutms1tet6f,_t6_stsriuiztnefg_,t6_string_lenlgitbhf,sapfs_err*o*re_tror);
int
libfsapfs_volume_get_next_file_entry_identifier(libfsapfs_volume*_tolumuei,nt64*_tdentifielri,bfsapfs_error*_terror);
int
libfsapfs_volume_get_file_entry_by_identifier(libfsapfs_vo*lvuuoiimlndeute_6nte4tl,_itfbifesra,pfs_file_e*n*tfriyl_t_elnitbrfys,apfs_er*r*oerr_tor);
int
libfsapfs_volume_get_root_directory(libfsapfs_volume*_tolumlei,bfsapfs_file_entr*y*_tile_entlriyb,fsapfs_erro*r*_trror);
int
libfsapfs_volume_get_file_entry_by_utf8_path(libfsap*fuusit_fuv*ct8tovo8_flon_i8ulsttz_mutresemi__ntrt,gi,ng_liebnfgstahp,fs_file_e*n*tfriyl_t_einbtfrsya,pfs_e*r*reorrr_tr);
int
libfsapfs_volume_get_file_entry_by_utf16_path(libfsapfu*siu_tv*ctfovo11ulon66tuls_fmuttsi1emtz6_re_t,i_nttgr,ing_liebnfgstahp,fs_file_e*nftirlyel_tebnftsrayp,fs*_eerrrroorr_tint
libfsapfs_volume_open_wide(libfsapfs_volume_tvolumec,onswtchar_tfilename,intaccess_flags,libfsapfs_error_t**error);
Available when compiled with libbfio support:
int
libfsapfs_volume_open_file_io_handle(libfsapfs_volum*ev_tlulmieb,bfio_handl*ef_tle_io_haacnicdneltses,_fllaigbsf,sapfs_err*o*re_tror);
File entry functions
int
libfsapfs_file_entry_free(libfsapfs_file_entry_t **file_entry, libfsapfs_error_t **error);
int
libfsapfs_file_entry_get_identifier(libfsapfs_file_entry*_tile_entryu,int64_tidentifierl,ibfsapfs_error_t*error);
int
libfsapfs_file_entry_get_parent_identifier(libfsapfs_file_ent*rfyi_te_enutirnyt*,6p4a_tent_identifliiebrf,sapfs_err*o*re_tror);
int
libfsapfs_file_entry_get_parent_file_entry(libfsapfs_file_efnitlrely__btnftsrayp,fs_file_e*nptarrye_tt_filel_ebnftsrayp,fs_e*rerrorro_tint
libfsapfs_file_entry_get_creation_time(libfsapfs_file_entry_tfile_entryi,nt64*_tosix_timlei,bfsapfs_error*_terror);
int
libfsapfs_file_entry_get_modification_time(libfsapfs_file_entr*yf_tle_entirnyt,64*_tosix_timlei,bfsapfs_error*_terror);
int
libfsapfs_file_entry_get_inode_change_time(libfsapfs_file_entry*_tile_entriyn,t64*_tosix_tilmieb,fsapfs_erro*r*_trror);
int
libfsapfs_file_entry_get_access_time(libfsapfs_file_entry*_tile_entryi,nt64_tposix_timel,ibfsapfs_error_t*error);
int
libfsapfs_file_entry_get_owner_identifier(libfsapfs_file_entr*yf_tle_enturiyn,t*3o2w_ter_identifliiebrf,sapfs_err*o*re_tror);
int
libfsapfs_file_entry_get_group_identifier(libfsapfs_file_ent*rfyi_te_enutirnyt*,3g2r_tup_identifileirb,fsapfs_erro*r*_trror);
int
libfsapfs_file_entry_get_file_mode(libfsapfs_file_entry_t*file_entryu,int16_tfile_model,ibfsapfs_error_t*error);
int
libfsapfs_file_entry_get_utf8_name_size(libfsapfs_file_entr*yf_tle_entsriyz,e*_ttf8_name_sizlei,bfsapfs_error*_terror);
int
libfsapfs_file_entry_get_utf8_name(libfsapfs_file_entr*yf_tle_enturiyn,t*8u_tf8_nasmiezu,et_t8_name_silzieb,fsapfs_err*o*re_tror);
int
libfsapfs_file_entry_get_utf16_name_size(libfsapfs_file_entr*yf_tle_entsriyz*,eu_tf16_name_silzieb,fsapfs_error*_terror);
int
libfsapfs_file_entry_get_utf16_name(libfsapfs_file_entr*yf_tle_enturiyn,t*1u6t_t16_nsaiumzteef,_t6_name_sliizbef,sapfs_err*o*re_tror);
int
libfsapfs_file_entry_get_utf8_symbolic_link_target_size(libfsapfs_file_e*nftirlye*_uteitnzfte8r_yts,tringl_sbifzsea,pfs_e*r*reorrr_tr);
int
libfsapfs_file_entry_get_utf8_symbolic_link_target(libfsapfs_file_e*nftirlye_*teiunntttfr88y_,tssttifrz8ie_n_gtt,ringl_sbifzsea,pfs_e*r*reorrr_tr);
int
libfsapfs_file_entry_get_utf16_symbolic_link_target_size(libfsapfs_file_efnitl*resuy_t_zftne1t_rt_ys,tringl_sbifzsea,pfs_e*r*reorrr_tr);
int
libfsapfs_file_entry_get_utf16_symbolic_link_target(libfsapfs_file_e*nftirlye_tei*nnutttr1fy61u,_tt_fsi1tz6re_i_nttgr,inlgi_sfiszaep,fs_e*rerrorro_tint
libfsapfs_file_entry_get_number_of_extended_attributes(libfsapfs_f*inlue*m_beienlirten_r_oyef__tterxyt,ended_attlriibbfustaepsf,s_e*rerrorro_tint
libfsapfs_file_entry_get_extended_attribute_by_index(liebxftseanpdfesd_f*iaifntlittelr_ile_ineubtntfrtesyr__ipt,nfdse_xe,xtended*_aetxttreinbdueltdie__ftts*ta*rpeifrbsru_terer,ror_t
int
libfsapfs_file_entry_get_number_of_sub_file_entries(libfsapfs_file*_nefunimtlbreiey_r_t_tnotfr_ys,ub_file_enltirbifessa,pfs_e*r*reorrr_tr);
int
libfsapfs_file_entry_get_sub_file_entry_by_index(libfsapfs_fsiulbe*__feiinliltener__yee_ntttlrriyyb,_isnadpefxs,_fil*e*_eunbt_rfyil_iteb_esnatprf*ys*,_errrroorr_t
int
libfsapfs_file_entry_get_sub_file_entry_by_utf8_name(libfsaup*tfufst8_fs_fi8isin_tl*tseref8t__c_tnlelotiginenn_t_glfret,esynna_gptrtfyhs,,_file*_esnutbr_yf_tllei_efnstarpyf,s*_eerrrroorr_tint
libfsapfs_file_entry_get_sub_file_entry_by_utf16_name(libfsapf*usut_tffif1in1s6l*t6i_ef1_s_c6setelo__nentrtit_inlretngiyng__,lftresyna,gptfhs,_fil*e*_eunbt_rfyil_iteb_esnatp*rf*yse,_errorror_t
ssize_t
libfsapfs_file_entry_read_buffer(libfsapfs_file_entry*_tile_entrvyo*,ibduffesri,ze_tuffer_sizel,ibfsapfs_error_t*error);
ssize_t
libfsapfs_file_entry_read_buffer_at_offset(libfsapfs_file_entr*yf_tle_entv*robyiu,dfsfibezuref,_ter_soifzfoe6f,4fl_itebtf,sapfs_err*o*re_tror);
off64_t
libfsapfs_file_entry_seek_offset(libfsapfs_file_entry_tfile_entryo,ff64_tffseti,nwthence,libfsapfs_error_t**error);
int
libfsapfs_file_entry_get_offset(libfsapfs_file_entry_t*file_entry,off64_t*offset,libfsapfs_error_t**error);
int
libfsapfs_file_entry_get_size(libfsapfs_file_entry_t*file_entry,size64_t*size,libfsapfs_error_t **error);
int
libfsapfs_file_entry_get_number_of_extents(libfsapfs_file_entr*yf_tle_en*tinrnuytm,ber_of_extenltisb,fsapfs_erro*r*_trror);
int
libfsapfs_file_entry_get_extent_by_index(libfsapfs_file_e*nfetixrltyee_ntentnt_*tifernfxyd6t,e4ex_,tt_osfi*fzesexe6tt4e,_ttu_*sneitxz3te2e,_tt_filbafgssa,pfs_e*r*reorrr_tr);
Extended attribute functions
int
libfsapfs_extended_attribute_free(libfsapfs_extended_attribute_t*extended_attributel,ibfsapfs_error_t*error);
int
libfsapfs_extended_attribute_get_utf8_name_size(libfsapfs_extended_att*reixbtuetned_td*_attsfti8rz_iesb_utrtienl,gi_sfiszaep,fs_e*rerrorro_tint
libfsapfs_extended_attribute_get_utf8_name(libfsapfs_extended_attr*iebxutteen_ted_at*tuuritinfubt8tu8_ft_i8ettz_,resi_ntrgi,nlgi_sfiszaep,fs*_eerrrroorr_tint
libfsapfs_extended_attribute_get_utf16_name_size(libfsapfs_extended_att*reixbtuetned_td*_attsfti1rz6ie_b_utttreil,nigb_ssiazpef,s*_eerrrroorr_tint
libfsapfs_extended_attribute_get_utf16_name(libfsapfs_extended_attr*iebxutteen_ted_at*tuurituinftbt1fu16s1t6_6e_z_,ttesr_itrnilgni,gb_ssiazpef,s*_eerrrroorr_tDESCRIPTION
The libfsapfs_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 "libfsapfs.h".
ENVIRONMENT
None
FILES
None
NOTES
libfsapfs allows to be compiled with wide character support (wchar_t).
To compile libfsapfs with wide character support use: ./configure --enable-wide-character-type=yes
or define: _UNICODE
or UNICODE
during compilation.
LIBFSAPFS_WIDE_CHARACTER_TYPE
in libfsapfs/features.h can be used to determine if libfsapfs was compiled with wide character support.
BUGS
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libfsapfs/issues
AUTHOR
These man pages are generated from "libfsapfs.h".
COPYRIGHT
Copyright (C) 2018-2019, 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 libfsapfs.h include file
libfsapfs December 3, 2018 libfsapfs(3)