auparse_init(3) — Linux manual page


AUPARSE_INIT(3)              Linux Audit API             AUPARSE_INIT(3)

NAME         top

       auparse_init - initialize an instance of the audit parsing

SYNOPSIS         top

       #include <auparse.h>

       auparse_state_t *auparse_init(ausource_t source, const void *b);

DESCRIPTION         top

       auparse_init initializes an instance of the audit parsing
       library. The function returns an opaque pointer to the parser's
       internal state. It is used in subsequent calls to the library so.
       The source variable determines where the library looks for data.
       Legal values can be:

            AUSOURCE_LOGS - use audit logs
            AUSOURCE_FILE - use a file
            AUSOURCE_FILE_ARRAY - use several files
            AUSOURCE_BUFFER - use a buffer
            AUSOURCE_BUFFER_ARRAY - use an array of buffers
            AUSOURCE_DESCRIPTOR - use a particular descriptor
            AUSOURCE_FILE_POINTER - use a stdio FILE pointer
            AUSOURCE_FEED - feed data to parser with auparse_feed()

       The pointer 'b' is used to set the file name, array of filenames,
       the buffer address, or an array of pointers to buffers, or the
       descriptor number based on what source is given. When the data
       source is an array of files or buffers, you would create an array
       of pointers with the last one being a NULL pointer. Buffers
       should be NUL terminated.

       The data structure returned by auparse_init is not thread-safe.
       If you need to use it in a multithreaded program, you will need
       to add locking around any use of the data structure.

RETURN VALUE         top

       Returns a NULL pointer if an error occurs; otherwise, the return
       value is an opaque pointer to the parser's internal state.

SEE ALSO         top

       auparse_reset(3), auparse_destroy(3).  auparse_feed(3).

AUTHOR         top

       Steve Grubb

COLOPHON         top

       This page is part of the audit (Linux Audit) project.
       Information about the project can be found at 
       ⟨⟩.  If you have a bug
       report for this manual page, send it to
       This page was obtained from the project's upstream Git repository
       ⟨⟩ on
       2023-12-22.  (At that time, the date of the most recent commit
       that was found in the repository was 2023-11-30.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to

Red Hat                         Jan 2023                 AUPARSE_INIT(3)

Pages that refer to this page: auparse_destroy(3)auparse_new_buffer(3)auparse_reset(3)auparse_set_eoe_timeout(3)