libsigscan.h — Library for binary signature scanning

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

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

       Copyright (C) 2014-2024, 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 libsigscan_get_version() function is used to retrieve the library version.

       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.

       libsigscan.h — Library for binary signature scanning

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

       the libsigscan.h include file

libsigscan                                         May 3, 2019                                     libsigscan(3)

#include<libsigscan.h>

       Support functions

       constchar*libsigscan_get_version(void);

       intlibsigscan_get_access_flags_read(void);

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

       intlibsigscan_set_codepage(intcodepage, libsigscan_error_t**error);

       Notify functions

       voidlibsigscan_notify_set_verbose(intverbose);

       intlibsigscan_notify_set_stream(FILE*stream, libsigscan_error_t**error);

       intlibsigscan_notify_stream_open(constchar*filename, libsigscan_error_t**error);

       intlibsigscan_notify_stream_close(libsigscan_error_t**error);

       Error functions

       voidlibsigscan_error_free(libsigscan_error_t**error);

       intlibsigscan_error_fprint(libsigscan_error_t*error, FILE*stream);

       intlibsigscan_error_sprint(libsigscan_error_t*error, char*string, size_tsize);

       intlibsigscan_error_backtrace_fprint(libsigscan_error_t*error, FILE*stream);

       intlibsigscan_error_backtrace_sprint(libsigscan_error_t*error, char*string, size_tsize);

       Scanner functions

       intlibsigscan_scanner_initialize(libsigscan_scanner_t**scanner, libsigscan_error_t**error);

       intlibsigscan_scanner_free(libsigscan_scanner_t**scanner, libsigscan_error_t**error);

       intlibsigscan_scanner_signal_abort(libsigscan_scanner_t*scanner, libsigscan_error_t**error);

       intlibsigscan_scanner_set_scan_buffer_size(libsigscan_scanner_t*scanner,    size_tscan_buffer_size,
           libsigscan_error_t**error);

       intlibsigscan_scanner_add_signature(libsigscan_scanner_t*scanner,     constchar*identifier,
           size_tidentifier_length,  off64_tpattern_offset,  constuint8_t*pattern,  size_tpattern_size,
           uint32_tsignature_flags, libsigscan_error_t**error);

       intlibsigscan_scanner_scan_start(libsigscan_scanner_t*scanner,    libsigscan_scan_state_t*scan_state,
           libsigscan_error_t**error);

       intlibsigscan_scanner_scan_stop(libsigscan_scanner_t*scanner,    libsigscan_scan_state_t*scan_state,
           libsigscan_error_t**error);

       intlibsigscan_scanner_scan_buffer(libsigscan_scanner_t*scanner,   libsigscan_scan_state_t*scan_state,
           constuint8_t*buffer, size_tbuffer_size, libsigscan_error_t**error);

       intlibsigscan_scanner_scan_file(libsigscan_scanner_t*scanner,    libsigscan_scan_state_t*scan_state,
           constchar*filename, libsigscan_error_t**error);

       Available when compiled with wide character string support:

       intlibsigscan_scanner_scan_file_wide(libsigscan_scanner_t*scanner,  libsigscan_scan_state_t*scan_state,
           constwchar_t*filename, libsigscan_error_t**error);

       Available when compiled with libbfio support:

       intlibsigscan_scanner_scan_file_io_handle(libsigscan_scanner_t*scanner,
           libsigscan_scan_state_t*scan_state, libbfio_handle_t*file_io_handle, libsigscan_error_t**error);

       Scan state functions

       intlibsigscan_scan_state_initialize(libsigscan_scan_state_t**scan_state, libsigscan_error_t**error);

       intlibsigscan_scan_state_free(libsigscan_scan_state_t**scan_state, libsigscan_error_t**error);

       intlibsigscan_scan_state_set_data_size(libsigscan_scan_state_t*scan_state,     size64_tdata_size,
           libsigscan_error_t**error);

       intlibsigscan_scan_state_get_number_of_results(libsigscan_scan_state_t*scan_state, int*number_of_results,
           libsigscan_error_t**error);

       intlibsigscan_scan_state_get_result(libsigscan_scan_state_t*scan_state,       intresult_index,
           libsigscan_scan_result_t**scan_result, libsigscan_error_t**error);

       Scan result functions

       intlibsigscan_scan_result_free(libsigscan_scan_result_t**scan_result, libsigscan_error_t**error);

       intlibsigscan_scan_result_get_identifier_size(libsigscan_scan_result_t*scan_result,
           size_t*identifier_size, libsigscan_error_t**error);

       intlibsigscan_scan_result_get_identifier(libsigscan_scan_result_t*scan_result,     char*identifier,
           size_tidentifier_size, libsigscan_error_t**error);