1POSIX_TRACE_GET_ATTR(P)    POSIX Programmer's Manual   POSIX_TRACE_GET_ATTR(P)
2
3
4

NAME

6       posix_trace_get_attr,   posix_trace_get_status  -  retrieve  the  trace
7       attributes or trace status (TRACING)
8

SYNOPSIS

10       #include <trace.h>
11
12       int posix_trace_get_attr(trace_id_t trid, trace_attr_t *attr);
13       int posix_trace_get_status(trace_id_t trid,
14              struct posix_trace_status_info *statusinfo);
15
16

DESCRIPTION

18       The posix_trace_get_attr() function shall copy the  attributes  of  the
19       active  trace  stream  identified by trid into the object pointed to by
20       the attr argument.   If the Trace Log option  is  supported,  trid  may
21       represent a pre-recorded trace log.
22
23       The  posix_trace_get_status()  function  shall return, in the structure
24       pointed to by the statusinfo argument, the current trace status for the
25       trace  stream  identified  by  the  trid  argument. These status values
26       returned in the structure pointed to  by  statusinfo  shall  have  been
27       appropriately  read  to ensure that the returned values are consistent.
28        If the Trace Log option is supported and the trid argument refers to a
29       pre-recorded  trace  stream, the status shall be the status of the com‐
30       pleted trace stream.
31
32       Each time the posix_trace_get_status() function is  used,  the  overrun
33       status  of  the  trace  stream shall be reset to POSIX_TRACE_NO_OVERRUN
34       immediately after the call completes.    If the  Trace  Log  option  is
35       supported,  the posix_trace_get_status() function shall behave the same
36       as when the option is not supported except for  the  following  differ‐
37       ences:
38
39        * If  the  trid  argument refers to a trace stream with log, each time
40          the posix_trace_get_status() function is used, the log overrun  sta‐
41          tus of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN and
42          the flush_error status shall be reset to zero immediately after  the
43          call completes.
44
45        * If the trid argument refers to a pre-recorded trace stream, the sta‐
46          tus returned shall be the status of the completed trace  stream  and
47          the status values of the trace stream shall not be reset.
48

RETURN VALUE

50       Upon  successful  completion,  these  functions shall return a value of
51       zero. Otherwise, they shall return the corresponding error number.
52
53       The posix_trace_get_attr() function stores the trace attributes in  the
54       object pointed to by attr, if successful.
55
56       The  posix_trace_get_status()  function  stores the trace status in the
57       object pointed to by statusinfo, if successful.
58

ERRORS

60       These functions shall fail if:
61
62       EINVAL The trace stream argument trid does not correspond  to  a  valid
63              active trace stream or a valid trace log.
64
65
66       The following sections are informative.
67

EXAMPLES

69       None.
70

APPLICATION USAGE

72       None.
73

RATIONALE

75       None.
76

FUTURE DIRECTIONS

78       None.
79

SEE ALSO

81       posix_trace_attr_destroy() , posix_trace_attr_init() , posix_trace_cre‐
82       ate()  ,  posix_trace_open()  ,  the   Base   Definitions   volume   of
83       IEEE Std 1003.1-2001, <trace.h>
84

86       Portions  of  this text are reprinted and reproduced in electronic form
87       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
88       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
89       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
90       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
91       event of any discrepancy between this version and the original IEEE and
92       The  Open Group Standard, the original IEEE and The Open Group Standard
93       is the referee document. The original Standard can be  obtained  online
94       at http://www.opengroup.org/unix/online.html .
95
96
97
98IEEE/The Open Group                  2003              POSIX_TRACE_GET_ATTR(P)
Impressum