Ubuntu Manpage: libsmraw.h — Library to access the storage media (SM) (split) RAW format

Provided by: libsmraw-dev_20181227-2.1build2_amd64

NAME

       libsmraw.h — Library to access the storage media (SM) (split) RAW format

LIBRARY

       library “libsmraw”

SYNOPSIS

       #include <libsmraw.h>

       Support functions

       const char *
       libsmraw_get_version(void);

       int
       libsmraw_get_access_flags_read(void);

       int
       libsmraw_get_access_flags_read_write(void);

       int
       libsmraw_get_access_flags_write(void);

       int
       libsmraw_get_codepage(int *codepage, libsmraw_error_t **error);

       int
       libsmraw_set_codepage(int codepage, libsmraw_error_t **error);

       int
       libsmraw_glob(consctha*rfilenames,ize_tilename_lengthc,ha*r*filenames[]i,nt*number_of_filenames,libsmraw_error_t**error);

       int
       libsmraw_glob_free(char *filenames[], int number_of_filenames, libsmraw_error_t **error);

       int
       libsmraw_glob_wide(conswtchar_tfilenamsei,zef_tlename_lengtwhc,har*_tfilenames[i*]nn,tumber_of_filenamelsi,bsmraw_error*_terror);

       int
       libsmraw_glob_wide_free(wchar_t *filenames[], int number_of_filenames, libsmraw_error_t **error);

       Notify functions

       void
       libsmraw_notify_set_verbose(int verbose);

       int
       libsmraw_notify_set_stream(FILE *stream, libsmraw_error_t **error);

       int
       libsmraw_notify_stream_open(const char *filename, libsmraw_error_t **error);

       int
       libsmraw_notify_stream_close(libsmraw_error_t **error);

       Error functions

       void
       libsmraw_error_free(libsmraw_error_t **error);

       int
       libsmraw_error_fprint(libsmraw_error_t *error, FILE *stream);

       int
       libsmraw_error_sprint(libsmraw_error_t *error, char *string, size_t size);

       int
       libsmraw_error_backtrace_fprint(libsmraw_error_t *error, FILE *stream);

       int
       libsmraw_error_backtrace_sprint(libsmraw_error_t *error, char *string, size_t size);

       Handle functions

       int
       libsmraw_handle_initialize(libsmraw_handle_t **handle, libsmraw_error_t **error);

       int
       libsmraw_handle_free(libsmraw_handle_t **handle, libsmraw_error_t **error);

       int
       libsmraw_handle_signal_abort(libsmraw_handle_t *handle, libsmraw_error_t **error);

       int
       libsmraw_handle_open(libsmraw_handle*_tandclcoeh*nf,asirtlenames[]i,nntumber_of_filenamesi,natccess_flagsl,ibsmraw_error_t*error);

       int
       libsmraw_handle_close(libsmraw_handle_t *handle, libsmraw_error_t **error);

       ssize_t
       libsmraw_handle_read_buffer(libsmraw_handle_t*handle,void*buffer,size_tbuffer_size,libsmraw_error_t**error);

       ssize_t
       libsmraw_handle_read_buffer_at_offset(libsmraw_handle*_tandlveo*,ibduffesri,zeb_tffer_sizoef,f64o_tfselti,bsmraw_error*_terror);

       ssize_t
       libsmraw_handle_write_buffer(libsmraw_handle_t*handle,constvoid*buffer,size_tbuffer_size,libsmraw_error_t*error);

       ssize_t
       libsmraw_handle_write_buffer_at_offset(libsmraw_handl*eh_tndcloveno*,sibtduffesri,zeb_tffer_sizoef,f64o_tfselti,bsmraw_error*_terror);

       off64_t
       libsmraw_handle_seek_offset(libsmraw_handle_t *handle, off64_t offset,intwhence,libsmraw_error_t**error);

       int
       libsmraw_handle_get_offset(libsmraw_handle_t *handle, off64_t *offset, libsmraw_error_t **error);

       int
       libsmraw_handle_set_maximum_number_of_open_handles(libsmraw_hamn*adhxlaiiennm_tutlme_,number_of_open_hanldilbessm,raw_er*r*oerr_tor);

       int
       libsmraw_handle_get_segment_filename_size(libsmraw_handle_t*handle,size_tfilename_sizel,ibsmraw_error_t*error);

       int
       libsmraw_handle_get_segment_filename(libsmraw_handle*_tandlceh,a*rfilenames,ize_tilename_sizel,ibsmraw_error_t*error);

       int
       libsmraw_handle_set_segment_filename(libsmraw_handle_thandlceo,ncsh*tafrilenamsei,zef_tlename_lengtlhi,bsmraw_error*_terror);

       int
       libsmraw_handle_get_maximum_segment_size(libsmraw_handl*eh_tndlsei,ze64*_taximum_segment_sizlei,bsmraw_error*_terror);

       int
       libsmraw_handle_set_maximum_segment_size(libsmraw_handle*_tandlsei,ze64m_tximum_segment_sizlei,bsmraw_error*_terror);

       int
       libsmraw_handle_get_filename_size(libsmraw_handle_t*handle,size_t*filename_size,libsmraw_error_t**error);

       int
       libsmraw_handle_get_filename(libsmraw_handle_t*handle,char*filename,size_tfilename_size,libsmraw_error_t*error);

       Available when compiled with wide character string support:

       int
       libsmraw_handle_open_wide(libsmraw_handl*eh_tndwlcehc,aor*nf_ittlenames[in]nu,tmber_of_filenameiasnc,tcess_flaglsi,bsmraw_error*_terror);

       int
       libsmraw_handle_get_segment_filename_size_wide(libsmraw_handle_thandles,ize*_tilename_sizlei,bsmraw_error*_terror);

       int
       libsmraw_handle_get_segment_filename_wide(libsmraw_handl*eh_tndwlceh,a*rf_tlenamsei,zef_tlename_sizlei,bsmraw_error*_terror);

       int
       libsmraw_handle_set_segment_filename_wide(libsmraw_handle*_tandclowenc,shta*rf_tlenasmiezf,ei_tename_lengltihb,smraw_erro*r*_trror);

       int
       libsmraw_handle_get_filename_size_wide(libsmraw_handle_t*handle,size_t*filename_size,libsmraw_error_t**error);

       int
       libsmraw_handle_get_filename_wide(libsmraw_handle_thandlew,char_tfilenames,ize_tilename_sizlei,bsmraw_error*_terror);

       Available when compiled with libbfio support:

       int
       libsmraw_handle_open_file_io_pool(libsmraw_handl*eh_tndllieb,bfio_pool*_tile_io_pooialnc,tcess_flaglsi,bsmraw_error*_terror);

       int
       libsmraw_handle_get_file_io_handle(libsmraw_handle_thandlel,ibbfio_handle*_tfile_io_handllei,bsmraw_error*_terror);

       Meta data functions

       int
       libsmraw_handle_get_media_size(libsmraw_handle_t*handle, size64_t *media_size, libsmraw_error_t **error);

       int
       libsmraw_handle_set_media_size(libsmraw_handle_t *handle, size64_t media_size, libsmraw_error_t **error);

       int
       libsmraw_handle_get_bytes_per_sector(libsmraw_handle_t*handle,uint32_tbytes_per_sectorl,ibsmraw_error_t*error);

       int
       libsmraw_handle_set_bytes_per_sector(libsmraw_handle_thandleu,int32_tbytes_per_sector,libsmraw_error_t**error);

       int
       libsmraw_handle_get_media_type(libsmraw_handle_t *handle, uint8_t *media_type, libsmraw_error_t **error);

       int
       libsmraw_handle_set_media_type(libsmraw_handle_t *handle, uint8_t media_type, libsmraw_error_t **error);

       int
       libsmraw_handle_get_media_flags(libsmraw_handle_t *handle, uint8_t *media_flags,libsmraw_error_t**error);

       int
       libsmraw_handle_set_media_flags(libsmraw_handle_t*handle, uint8_t media_flags, libsmraw_error_t **error);

       int
       libsmraw_handle_get_number_of_information_values(libsmraw_hand*lh*ean_iutdnmltbee,r_of_information_valliubessm,raw_er*r*oerr_tor);

       int
       libsmraw_handle_get_information_value_identifier_size(libsmrawi_hfa*onhirdanmlntaedt_iteo,n_value*_iiidnzedene_xti,fierl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_information_value_identifier(libsmraw_hnafn*odhirlanmenta_ttlieo,n_value_*iiinnddtee8nix_sd,tiiefzniete_rtf,ierl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf8_information_value_size(libsmraw_hu*a*iinhcnddaotelnn8neds_si_ttiidtefze,iene_rti,fier_les*niugzttefh_,t_string_siibzsem,raw_er*r*oerr_tor);

       int
       libsmraw_handle_get_utf8_information_value(libsmraw_han*dhulaci*enoni_ntdtls8eet_,ttiisdfieizneetr_,tfier_lu*eiunntgtft88h_,tssttifrz8ie_n_gtt,ringl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_set_utf8_information_value(libsmraw_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,ieru_*lcnueottnn8fgs_ttt_hs,tsuritizfne8g_,tstring_lelnigbtshm,raw_er*r*oerr_tor);

       int
       libsmraw_handle_get_utf16_information_value_size(libsmraw_han*dhu*laciienond_ntetls8niet_sd,tiiefzniete_rtf,ier_lsueitnzfge1t_ht_,stringl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf16_information_value(libsmraw_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,ier_luei*nnugttt1fh61,_t_ssttifrz1ie6n_gts,tringl_sbiszmer,aw_er*r*oerr_tor);

       int
       libsmraw_handle_set_utf16_information_value(libsmraw_hau*n*iidhcndlaoteenn8ni_s_sdtlttiieefzn,iete_rtf,ieru_*lcnueottnn1fgs61tt_ht_,ssttifrz1ie6n_gts,tring_lleinbgstmhr,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_number_of_integrity_hash_values(libsmraw*_hua*mnhibdanelntred__otef,_integrity_hash_valliubessm,raw_er*r*oerr_tor);

       int
       libsmraw_handle_get_integrity_hash_value_identifier_size(libsmrianwt_hga*irnhnidattlnyed__htea,sh_val*uiesd_eiznnetd_etfxi,elri_ssimzrea,w_e*rerrorro_tint
       libsmraw_handle_get_integrity_hash_value_identifier(libsmirnatwe_h*irahninattdnyld_elh_at,sh_valu*eui_dinentnid8tsde_iextfzn,iete_rtf,ierl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf8_integrity_hash_value_size(libsmraw_han*u*dhiilacndenote_n8nitls_sdettiie,fzniete_rtf,ier_lsueitnzfge8t_hts,tringl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf8_integrity_hash_value(libsmraw_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,ier_lu*eiunntgtft88h_,tssttifrz8ie_n_gtt,ring_siibzsem,raw_er*r*oerr_tor);

       int
       libsmraw_handle_set_utf8_integrity_hash_value(libsmraw_han*u*dhiilacndenote_n8nitls_sdettiie,fzniete_rtf,ieru*_ulcnteotfnn88gs_tttssthtif,rz8ie_n_gtt,ring_lleinbgstmhr,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf16_integrity_hash_value_size(libsmraw_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,ier_lsueitnzfge1t_ht_,stringl_sbiszmer,aw_e*r*reorrr_tr);

       int
       libsmraw_handle_get_utf16_integrity_hash_value(libsmraw_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,ier_luei*nnugttt1fh61,_t_ssttifrz1ie6n_gts,trinlgi_ssimzrea,w_e*rerrorro_tint
       libsmraw_handle_set_utf16_integrity_hash_value(libsmrawu*_ih*cndahotenan8nidns_sdldttiieelfzn_iett,e_rtf,ieru_*lcnueottnn1fgs61tt_ht_,ssttifrz1ie6n_gts,tring_lleinbgstmhr,aw_e*r*reorrr_tr);

DESCRIPTION

       The libsmraw_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 "libsmraw.h".

ENVIRONMENT

       None

FILES

       None

NOTES

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

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

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

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2010-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.

NAME

LIBRARY

SYNOPSIS

DESCRIPTION

RETURN VALUES

ENVIRONMENT

FILES

NOTES

BUGS

AUTHOR

COPYRIGHT

SEE ALSO