NAME

       libsigscan.h — Library for binary signature scanning

LIBRARY

       library “libsigscan”

SYNOPSIS

       #include <libsigscan.h>

       Support functions

       const char *
       libsigscan_get_version(void);

       int
       libsigscan_get_access_flags_read(void);

       int
       libsigscan_get_codepage(int *codepage, libsigscan_error_t **error);

       int
       libsigscan_set_codepage(int codepage, libsigscan_error_t **error);

       Notify functions

       void
       libsigscan_notify_set_verbose(int verbose);

       int
       libsigscan_notify_set_stream(FILE *stream, libsigscan_error_t **error);

       int
       libsigscan_notify_stream_open(const char *filename, libsigscan_error_t **error);

       int
       libsigscan_notify_stream_close(libsigscan_error_t **error);

       Error functions

       void
       libsigscan_error_free(libsigscan_error_t **error);

       int
       libsigscan_error_fprint(libsigscan_error_t *error, FILE *stream);

       int
       libsigscan_error_sprint(libsigscan_error_t *error, char *string, size_t size);

       int
       libsigscan_error_backtrace_fprint(libsigscan_error_t *error, FILE *stream);

       int
       libsigscan_error_backtrace_sprint(libsigscan_error_t *error, char *string, size_t size);

       Scanner functions

       int
       libsigscan_scanner_initialize(libsigscan_scanner_t **scanner, libsigscan_error_t **error);

       int
       libsigscan_scanner_free(libsigscan_scanner_t **scanner, libsigscan_error_t **error);

       int
       libsigscan_scanner_signal_abort(libsigscan_scanner_t *scanner, libsigscan_error_t **error);

       int
       libsigscan_scanner_set_scan_buffer_size(libsigscan_scanner*_tcannesri,zes_tan_buffer_sizlei,bsigscan_error_t*error);

       int
       libsigscan_scanner_add_signature(libsigscan_scan**nsieccdrache_oanitnnrtsdesiiertfzn,iete_rtf,ier_lopefanftg6tt4eh_,tnu*_ppocnasafottitfn8tztss_eeettr_tntnu,,_ssniitgz3ne2a,_ture_filbasgisg,scan_e*r*reorrr_tr);

       int
       libsigscan_scanner_scan_start(libsigscan_scanne*rs_tannelri,bsigscan_scan_state*_tcan_statlei,bsigscan_error*_terror);

       int
       libsigscan_scanner_scan_stop(libsigscan_scanner*_tcannelri,bsigscan_scan_state*_tcan_statlei,bsigscan_error*_terror);

       int
       libsigscan_scanner_scan_buffer(libsigscan_scan*nsecral_itnbesri,gscan_scan_st*astcea_t_sciton*antbts8uet_s,tfibezuref,_ter_sliizbes,igscan_err*o*re_tror);

       int
       libsigscan_scanner_scan_file(libsigscan_scanne*rs_tannleirb,sigscan_scan_stat*es_tan_stactoc*enhf,saitrlenlaimbes,igscan_err*o*re_tror);

       Available when compiled with wide character string support:

       int
       libsigscan_scanner_scan_file_wide(libsigscan_scan*nsecral_itnbesri,gscan_scan_sta*tsec_tn_stcwaoctnh*esaf,tri_tenlaimbes,igscan_err*o*re_tror);

       Available when compiled with libbfio support:

       int
       libsigscan_scanner_scan_file_io_handle(libsigscan_sc*aslncinabensrni_gtrs,can_scan_sstcaatnle__bttbaftieo,_h*afnidllee__to_hiabnsdilges,can*_eerrrroorr_tint
       libsigscan_scan_state_initialize(libsigscan_scan_state_t **scan_state, libsigscan_error_t **error);

       int
       libsigscan_scan_state_free(libsigscan_scan_state_t **scan_state, libsigscan_error_t **error);

       int
       libsigscan_scan_state_set_data_size(libsigscan_scan_state*_tcan_states,ize64_tata_sizel,ibsigscan_error_t*error);

       int
       libsigscan_scan_state_get_number_of_results(libsigscan_scan_stat*es_tan_s*tnaiutnmetb,er_of_resullitbss,igscan_err*o*re_tror);

       int
       libsigscan_scan_state_get_result(libsigscan_scan_s*tsacrtaeens_utsnlttta_tileni,dbesxi,gscan_scan_res*u*lstc_tn_relsiublsti,gscan_er*r*oerr_tor);

       Scan result functions

       int
       libsigscan_scan_result_free(libsigscan_scan_result_t **scan_result, libsigscan_error_t **error);

       int
       libsigscan_scan_result_get_identifier_size(libsigscan_scan_resu*lstc_tn_ressui*lzited,_tntifier_sliizbes,igscan_err*o*re_tror);

       int
       libsigscan_scan_result_get_identifier(libsigscan_scan_resu*lstc_tn_re*sciuhdlaetrn,tifsiiiezdree,_ttifier_sliizbes,igscan_err*o*re_tror);

DESCRIPTION

       The libsigscan_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 "libsigscan.h".

ENVIRONMENT

       None

FILES

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

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

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

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2014-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 libsigscan.h include file

libsigscan                                        June 27, 2015                                    libsigscan(3)