posix_trace_attr_getclockres(3p)

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

NAME

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

SYNOPSIS

18       #include <time.h>
19       #include <trace.h>
20
21       int posix_trace_attr_getclockres(const trace_attr_t *attr,
22              struct timespec *resolution);
23       int posix_trace_attr_getcreatetime(const trace_attr_t *attr,
24              struct timespec *createtime);
25
26
27       #include <trace.h>
28       int posix_trace_attr_getgenversion(const trace_attr_t *attr,
29              char *genversion);
30       int posix_trace_attr_getname(const trace_attr_t *attr,
31              char *tracename);
32       int posix_trace_attr_setname(trace_attr_t *attr,
33              const char *tracename);
34
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. Oth‐
79       erwise, 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
97       The following sections are informative.
98

EXAMPLES

100       None.
101

APPLICATION USAGE

103       None.
104

RATIONALE

106       None.
107

FUTURE DIRECTIONS

109       None.
110

COPYRIGHT

117       Portions of this text are reprinted and reproduced in  electronic  form
118       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
119       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
120       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
121       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
122       event of any discrepancy between this version and the original IEEE and
123       The Open Group Standard, the original IEEE and The Open Group  Standard
124       is  the  referee document. The original Standard can be obtained online
125       at http://www.opengroup.org/unix/online.html .
126
127
128
129IEEE/The Open Group                  2003     POSIX_TRACE_ATTR_GETCLOCKRES(3P)