NAME

       libsmdev.h — Library to access and read the storage media (SM) devices

LIBRARY

       library “libsmdev”

SYNOPSIS

       #include <libsmdev.h>

       Support functions

       const char *
       libsmdev_get_version(void);

       int
       libsmdev_get_access_flags_read(void);

       int
       libsmdev_get_access_flags_read_write(void);

       int
       libsmdev_get_access_flags_write(void);

       int
       libsmdev_get_codepage(int *codepage, libsmdev_error_t **error);

       int
       libsmdev_set_codepage(int codepage, libsmdev_error_t **error);

       int
       libsmdev_check_device(const char *filename, libsmdev_error_t **error);

       #endif

       Available when compiled with wide character string support:

       int
       libsmdev_check_device_wide(const wchar_t *filename, libsmdev_error_t **error);

       Notify functions

       void
       libsmdev_notify_set_verbose(int verbose);

       int
       libsmdev_notify_set_stream(FILE *stream, libsmdev_error_t **error);

       int
       libsmdev_notify_stream_open(const char *filename, libsmdev_error_t **error);

       int
       libsmdev_notify_stream_close(libsmdev_error_t **error);

       Error functions

       void
       libsmdev_error_free(libsmdev_error_t **error);

       int
       libsmdev_error_fprint(libsmdev_error_t *error, FILE *stream);

       int
       libsmdev_error_sprint(libsmdev_error_t *error, char *string, size_t size);

       int
       libsmdev_error_backtrace_fprint(libsmdev_error_t *error, FILE *stream);

       int
       libsmdev_error_backtrace_sprint(libsmdev_error_t *error, char *string, size_t size);

       Handle functions

       int
       libsmdev_handle_initialize(libsmdev_handle_t **handle, libsmdev_error_t **error);

       int
       libsmdev_handle_free(libsmdev_handle_t **handle, libsmdev_error_t **error);

       int
       libsmdev_handle_signal_abort(libsmdev_handle_t *handle, libsmdev_error_t **error);

       int
       libsmdev_handle_open(libsmdev_handle_t*handle,constchar*filename,intaccess_flags,libsmdev_error_t**error);

       #endif int
       libsmdev_handle_close(libsmdev_handle_t *handle, libsmdev_error_t **error);

       ssize_t
       libsmdev_handle_read_buffer(libsmdev_handle_t*handle,uint8_t*buffer,size_tbuffer_size,libsmdev_error_t**error);

       ssize_t
       libsmdev_handle_read_buffer_at_offset(libsmdev_handl*eh_tndulien,t*8b_tffesri,zeb_tffer_sizoef,f64o_tfselti,bsmdev_error*_terror);

       ssize_t
       libsmdev_handle_write_buffer(libsmdev_handle_t*handle,constuint8_t*buffers,ize_tuffer_sizel,ibsmdev_error_t*error);

       ssize_t
       libsmdev_handle_write_buffer_at_offset(libsmdev_handl*eh_tndcloueni,sntt*8b_tffseirzb,eu_tfer_sizoef,f64o_tfselti,bsmdev_error*_terror);

       off64_t
       libsmdev_handle_seek_offset(libsmdev_handle_t *handle, off64_t offset,intwhence,libsmdev_error_t**error);

       int
       libsmdev_handle_get_offset(libsmdev_handle_t *handle, off64_t *offset, libsmdev_error_t **error);

       int
       libsmdev_handle_get_filename_size(libsmdev_handle_t*handle,size_t*filename_size,libsmdev_error_t**error);

       int
       libsmdev_handle_get_filename(libsmdev_handle_t*handle,char*filename,size_tfilename_size,libsmdev_error_t*error);

       #endif

       Available when compiled with wide character string support:

       int
       libsmdev_handle_open_wide(libsmdev_handle_thandle,constwchar_t*filename,intaccess_flags,libsmdev_error_t**error);

       int
       libsmdev_handle_get_filename_size_wide(libsmdev_handle_t*handle,size_t*filename_size,libsmdev_error_t**error);

       int
       libsmdev_handle_get_filename_wide(libsmdev_handle*_tandlwec,har_tfilenames,ize_tilename_sizel,ibsmdev_error_t*error);

       Meta data functions

       int
       libsmdev_handle_get_media_size(libsmdev_handle_t *handle, size64_t *media_size, libsmdev_error_t**error);

       int
       libsmdev_handle_get_bytes_per_sector(libsmdev_handle_thandleu,int32_tbytes_per_sector,libsmdev_error_t**error);

       int
       libsmdev_handle_get_media_type(libsmdev_handle_t *handle, uint8_t *media_type, libsmdev_error_t **error);

       int
       libsmdev_handle_get_bus_type(libsmdev_handle_t *handle, uint8_t *bus_type, libsmdev_error_t **error);

       int
       libsmdev_handle_get_utf8_information_value(libsmdev_han*dhulaci*enoni_ntdtls8eet_,ttisifidizeeenr_,tifieru_i*sonuinttzs8fet_,t_ssttifrz8ie_n_gtt,ringl_sbiszmed,ev_e*r*reorrr_tr);

       int
       libsmdev_handle_get_utf16_information_value(libsmdev_hu*a*iinhcnddaotelnn8nieds_sd_ttiietefzn,iete_rtf,iueircn*_tusn1tis6fzt_et6,_stsuritizfne1g_,t_string_siibzsem,dev_er*r*oerr_tor);

       int
       libsmdev_handle_get_number_of_sessions(libsmdev_handle_t*handle,int*number_of_sessionsl,ibsmdev_error_t*error);

       int
       libsmdev_handle_get_session(libsmdev_handl*eh_tnidinlnduetei,xn,t64*_ttart_sectouri,nt64*_tumber_of_sectorlsi,bsmdev_error*_terror);

       int
       libsmdev_handle_get_number_of_tracks(libsmdev_handle_t*handle,int*number_of_tracks,libsmdev_error_t**error);

       int
       libsmdev_handle_get_track(libsmdev_handl*eh_tnidinlnduetei,xn,t6*4s_tart_sectuoirn,t6*4n_tmber_of_sectourisn,t*8t_tplei,bsmdev_error*_terror);

       int
       libsmdev_handle_get_number_of_error_retries(libsmdev_handl*eh_tndulien,t*8n_tmber_of_error_retrileisb,smdev_err*o*re_tror);

       int
       libsmdev_handle_set_number_of_error_retries(libsmdev_handl*eh_tndulien,tn8u_tber_of_error_retrileisb,smdev_erro*r*_trror);

       int
       libsmdev_handle_get_error_granularity(libsmdev_handle_t*handle,size_terror_granularityl,ibsmdev_error_t*error);

       int
       libsmdev_handle_set_error_granularity(libsmdev_handle_thandles,ize_terror_granularity,libsmdev_error_t**error);

       int
       libsmdev_handle_get_error_flags(libsmdev_handle_t *handle, uint8_t *error_flags,libsmdev_error_t**error);

       int
       libsmdev_handle_set_error_flags(libsmdev_handle_t*handle, uint8_t error_flags, libsmdev_error_t **error);

       int
       libsmdev_handle_get_number_of_errors(libsmdev_handle_t*handle,int*number_of_errors,libsmdev_error_t**error);

       int
       libsmdev_handle_get_error(libsmdev_handle_t*handle,intindex,off64_t*offset,size64_t*size,libsmdev_error_t**error);

DESCRIPTION

       The libsmdev_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 "libsmdev.h".

ENVIRONMENT

       None

FILES

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

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

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

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2010-2016, 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 libsmdev.h include file

libsmdev                                         January 5, 2015                                     libsmdev(3)