posix_trace_eventtypelist_getnext_id(3p) — Linux manual page

PROLOG | NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | EXAMPLES | APPLICATION USAGE | RATIONALE | FUTURE DIRECTIONS | SEE ALSO | COPYRIGHT

POSIX_TR...TNEXT_ID(3P) POSIX Programmer's ManualPOSIX_TR...TNEXT_ID(3P)

PROLOG         top

       This manual page is part of the POSIX Programmer's Manual.  The
       Linux implementation of this interface may differ (consult the
       corresponding Linux manual page for details of Linux behavior),
       or the interface may not be implemented on Linux.

NAME         top

       posix_trace_eventtypelist_getnext_id,
       posix_trace_eventtypelist_rewind — iterate over a mapping of
       trace event types (TRACING)

SYNOPSIS         top

       #include <trace.h>

       int posix_trace_eventtypelist_getnext_id(trace_id_t trid,
           trace_event_id_t *restrict event, int *restrict unavailable);
       int posix_trace_eventtypelist_rewind(trace_id_t trid);

DESCRIPTION         top

       The first time posix_trace_eventtypelist_getnext_id() is called,
       the function shall return in the variable pointed to by event the
       first trace event type identifier of the list of trace events of
       the trace stream identified by the trid argument. Successive
       calls to posix_trace_eventtypelist_getnext_id() return in the
       variable pointed to by event the next trace event type identifier
       in that same list. Each time a trace event type identifier is
       successfully written into the variable pointed to by the event
       argument, the variable pointed to by the unavailable argument
       shall be set to zero. When no more trace event type identifiers
       are available, and so none is returned, the variable pointed to
       by the unavailable argument shall be set to a value different
       from zero.

       The posix_trace_eventtypelist_rewind() function shall reset the
       next trace event type identifier to be read to the first trace
       event type identifier from the list of trace events used in the
       trace stream identified by trid.

RETURN VALUE         top

       Upon successful completion, these functions shall return a value
       of zero. Otherwise, they shall return the corresponding error
       number.

       The posix_trace_eventtypelist_getnext_id() function stores the
       trace event type identifier value in the object pointed to by
       event, if successful.

ERRORS         top

       These functions shall fail if:

       EINVAL The trid argument was not a valid trace stream identifier.

       The following sections are informative.

EXAMPLES         top

       None.

APPLICATION USAGE         top

       None.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       The posix_trace_eventtypelist_getnext_id() and
       posix_trace_eventtypelist_rewind() functions may be removed in a
       future version.

SEE ALSO         top

       posix_trace_event(3p), posix_trace_eventid_equal(3p),
       posix_trace_getnext_event(3p)

       The Base Definitions volume of POSIX.1‐2017, trace.h(0p)

COPYRIGHT         top

       Portions of this text are reprinted and reproduced in electronic
       form from IEEE Std 1003.1-2017, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The
       Open Group Base Specifications Issue 7, 2018 Edition, Copyright
       (C) 2018 by the Institute of Electrical and Electronics
       Engineers, Inc and The Open Group.  In the event of any
       discrepancy between this version and the original IEEE and The
       Open Group Standard, the original IEEE and The Open Group
       Standard is the referee document. The original Standard can be
       obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page
       are most likely to have been introduced during the conversion of
       the source files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE/The Open Group               2017           POSIX_TR...TNEXT_ID(3P)

Pages that refer to this page: trace.h(0p)posix_trace_create(3p)