1POSIX_TRACE_ATTR_GETCLOCKRESP(O3SPI)X Programmer's MPaOnSuIaXl_TRACE_ATTR_GETCLOCKRES(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
11

NAME

13       posix_trace_attr_getclockres,           posix_trace_attr_getcreatetime,
14       posix_trace_attr_getgenversion,               posix_trace_attr_getname,
15       posix_trace_attr_setname — retrieve and set information about  a  trace
16       stream (TRACING)
17

SYNOPSIS

19       #include <time.h>
20       #include <trace.h>
21
22       int posix_trace_attr_getclockres(const trace_attr_t *attr,
23           struct timespec *resolution);
24       int posix_trace_attr_getcreatetime(const trace_attr_t *attr,
25           struct timespec *createtime);
26
27       #include <trace.h>
28
29       int posix_trace_attr_getgenversion(const trace_attr_t *attr,
30           char *genversion);
31       int posix_trace_attr_getname(const trace_attr_t *attr,
32           char *tracename);
33       int posix_trace_attr_setname(trace_attr_t *attr,
34           const char *tracename);
35

DESCRIPTION

37       The  posix_trace_attr_getclockres() function shall copy the clock reso‐
38       lution of the clock used to generate timestamps from the  clock-resolu‐
39       tion attribute of the attributes object pointed to by the attr argument
40       into the structure pointed to by the resolution argument.
41
42       The posix_trace_attr_getcreatetime()  function  shall  copy  the  trace
43       stream creation time from the creation-time attribute of the attributes
44       object pointed to by the attr argument into the structure pointed to by
45       the  createtime  argument.  The creation-time attribute shall represent
46       the time of creation of the trace stream.
47
48       The posix_trace_attr_getgenversion() function  shall  copy  the  string
49       containing version information from the generation-version attribute of
50       the attributes object pointed to by the attr argument into  the  string
51       pointed to by the genversion argument. The genversion argument shall be
52       the  address  of  a  character  array  which   can   store   at   least
53       {TRACE_NAME_MAX} characters.
54
55       The  posix_trace_attr_getname() function shall copy the string contain‐
56       ing the trace name from the  trace-name  attribute  of  the  attributes
57       object  pointed  to  by the attr argument into the string pointed to by
58       the tracename argument. The tracename argument shall be the address  of
59       a character array which can store at least {TRACE_NAME_MAX} characters.
60
61       The  posix_trace_attr_setname()  function  shall  set  the  name in the
62       trace-name attribute of the attributes object pointed to  by  the  attr
63       argument,  using  the trace name string supplied by the tracename argu‐
64       ment. If the supplied string contains more than {TRACE_NAME_MAX}  char‐
65       acters,  the name copied into the trace-name attribute may be truncated
66       to one less than the length of {TRACE_NAME_MAX} characters. The default
67       value is a null string.
68

RETURN VALUE

70       Upon  successful  completion,  these  functions shall return a value of
71       zero. Otherwise, they shall return the corresponding error number.
72
73       If successful, the posix_trace_attr_getclockres() function  stores  the
74       clock-resolution  attribute  value  in the object pointed to by resolu‐
75       tion.  Otherwise, the content of this object is unspecified.
76
77       If successful, the posix_trace_attr_getcreatetime() function stores the
78       trace  stream  creation  time  in  the object pointed to by createtime.
79       Otherwise, the content of this object is unspecified.
80
81       If successful, the posix_trace_attr_getgenversion() function stores the
82       trace version information in the string pointed to by genversion.  Oth‐
83       erwise, the content of this string is unspecified.
84
85       If successful, the posix_trace_attr_getname() function stores the trace
86       name  in the string pointed to by tracename.  Otherwise, the content of
87       this string is unspecified.
88

ERRORS

90       The  posix_trace_attr_getclockres(),  posix_trace_attr_getcreatetime(),
91       posix_trace_attr_getgenversion(),  and posix_trace_attr_getname() func‐
92       tions may fail if:
93
94       EINVAL The value specified by one of the arguments is invalid.
95
96       The following sections are informative.
97

EXAMPLES

99       None.
100

APPLICATION USAGE

102       None.
103

RATIONALE

105       None.
106

FUTURE DIRECTIONS

108       The  posix_trace_attr_getclockres(),  posix_trace_attr_getcreatetime(),
109       posix_trace_attr_getgenversion(),    posix_trace_attr_getname(),    and
110       posix_trace_attr_setname() functions may be removed in  a  future  ver‐
111       sion.
112

SEE ALSO

114       posix_trace_attr_destroy(),                       posix_trace_create(),
115       posix_trace_get_attr(), uname()
116
117       The Base Definitions volume of POSIX.1‐2008, <time.h>, <trace.h>
118
120       Portions of this text are reprinted and reproduced in  electronic  form
121       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
122       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
123       Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
124       cal and Electronics Engineers,  Inc  and  The  Open  Group.   (This  is
125       POSIX.1-2008  with  the  2013  Technical Corrigendum 1 applied.) In the
126       event of any discrepancy between this version and the original IEEE and
127       The  Open Group Standard, the original IEEE and The Open Group Standard
128       is the referee document. The original Standard can be  obtained  online
129       at http://www.unix.org/online.html .
130
131       Any  typographical  or  formatting  errors that appear in this page are
132       most likely to have been introduced during the conversion of the source
133       files  to  man page format. To report such errors, see https://www.ker
134       nel.org/doc/man-pages/reporting_bugs.html .
135
136
137
138IEEE/The Open Group                  2013     POSIX_TRACE_ATTR_GETCLOCKRES(3P)
Impressum