POSIX_TRACE_EVENTTYPELIST_GETNEXT_ID(3P)            POSIX Programmer's Manual           POSIX_TRACE_EVENTTYPELIST_GETNEXT_ID(3P)



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

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

SYNOPSIS
       #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
       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 argu-
       ment. 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 unavail-
       able 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
       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
       These functions shall fail if:

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


       The following sections are informative.

EXAMPLES
       None.

APPLICATION USAGE
       None.

RATIONALE
       None.

FUTURE DIRECTIONS
       None.

SEE ALSO
       posix_trace_event(),   posix_trace_getnext_event(),  posix_trace_trid_eventid_open(),  the  Base  Definitions  volume  of
       IEEE Std 1003.1-2001, <trace.h>

COPYRIGHT
       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003  Edition,  Standard  for
       Information  Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copy-
       right (C) 2001-2003 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.open-
       group.org/unix/online.html .



IEEE/The Open Group                                           2003                      POSIX_TRACE_EVENTTYPELIST_GETNEXT_ID(3P)