1POSIX_TRACE_EVENTTYPELIST_GEPTONSEIXXT_PIrDo(g3rPaP)mOmSeIrX'_sTRMAaCnEu_aElVENTTYPELIST_GETNEXT_ID(3P)
2
3
4

PROLOG

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

NAME

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

SYNOPSIS

16       #include <trace.h>
17
18       int posix_trace_eventtypelist_getnext_id(trace_id_t trid,
19           trace_event_id_t *restrict event, int *restrict unavailable);
20       int posix_trace_eventtypelist_rewind(trace_id_t trid);
21

DESCRIPTION

23       The  first  time  posix_trace_eventtypelist_getnext_id() is called, the
24       function shall return in the variable pointed to  by  event  the  first
25       trace  event  type  identifier of the list of trace events of the trace
26       stream  identified  by  the  trid   argument.   Successive   calls   to
27       posix_trace_eventtypelist_getnext_id()  return  in the variable pointed
28       to by event the next trace event type identifier  in  that  same  list.
29       Each  time  a  trace event type identifier is successfully written into
30       the variable pointed to by the event argument, the variable pointed  to
31       by  the  unavailable  argument shall be set to zero. When no more trace
32       event type identifiers are available, and  so  none  is  returned,  the
33       variable pointed to by the unavailable argument shall be set to a value
34       different from zero.
35
36       The posix_trace_eventtypelist_rewind() function shall  reset  the  next
37       trace  event  type  identifier to be read to the first trace event type
38       identifier from the list of trace events used in the trace stream iden‐
39       tified by trid.
40

RETURN VALUE

42       Upon  successful  completion,  these  functions shall return a value of
43       zero. Otherwise, they shall return the corresponding error number.
44
45       The posix_trace_eventtypelist_getnext_id() function  stores  the  trace
46       event  type identifier value in the object pointed to by event, if suc‐
47       cessful.
48

ERRORS

50       These functions shall fail if:
51
52       EINVAL The trid argument was not a valid trace stream identifier.
53
54       The following sections are informative.
55

EXAMPLES

57       None.
58

APPLICATION USAGE

60       None.
61

RATIONALE

63       None.
64

FUTURE DIRECTIONS

66       The posix_trace_eventtypelist_getnext_id()  and  posix_trace_eventtype‐
67       list_rewind() functions may be removed in a future version.
68

SEE ALSO

70       posix_trace_event(), posix_trace_eventid_equal(), posix_trace_get‐
71       next_event()
72
73       The Base Definitions volume of POSIX.1‐2017, <trace.h>
74
76       Portions of this text are reprinted and reproduced in  electronic  form
77       from  IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
78       table Operating System Interface (POSIX), The Open Group Base  Specifi‐
79       cations  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of
80       Electrical and Electronics Engineers, Inc and The Open Group.   In  the
81       event of any discrepancy between this version and the original IEEE and
82       The Open Group Standard, the original IEEE and The Open Group  Standard
83       is  the  referee document. The original Standard can be obtained online
84       at http://www.opengroup.org/unix/online.html .
85
86       Any typographical or formatting errors that appear  in  this  page  are
87       most likely to have been introduced during the conversion of the source
88       files to man page format. To report such errors,  see  https://www.ker
89       nel.org/doc/man-pages/reporting_bugs.html .
90
91
92
93IEEE/The Open Group                  20P1O7SIX_TRACE_EVENTTYPELIST_GETNEXT_ID(3P)
Impressum