1POSIX_TRACE_ATTR_GETCLOCKRESP(OPS)IX Programmer's MaPnOuSaIlX_TRACE_ATTR_GETCLOCKRES(P)
2
3
4

NAME

6       posix_trace_attr_getclockres,           posix_trace_attr_getcreatetime,
7       posix_trace_attr_getgenversion,               posix_trace_attr_getname,
8       posix_trace_attr_setname  -  retrieve and set information about a trace
9       stream (TRACING)
10

SYNOPSIS

12       #include <time.h>
13       #include <trace.h>
14
15       int posix_trace_attr_getclockres(const trace_attr_t *attr,
16              struct timespec *resolution);
17       int posix_trace_attr_getcreatetime(const trace_attr_t *attr,
18              struct timespec *createtime);
19
20
21       #include <trace.h>
22       int posix_trace_attr_getgenversion(const trace_attr_t *attr,
23              char *genversion);
24       int posix_trace_attr_getname(const trace_attr_t *attr,
25              char *tracename);
26       int posix_trace_attr_setname(trace_attr_t *attr,
27              const char *tracename);
28
29

DESCRIPTION

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

RETURN VALUE

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

ERRORS

84       The  posix_trace_attr_getclockres(),  posix_trace_attr_getcreatetime(),
85       posix_trace_attr_getgenversion(), and posix_trace_attr_getname()  func‐
86       tions may fail if:
87
88       EINVAL The value specified by one of the arguments is invalid.
89
90
91       The following sections are informative.
92

EXAMPLES

94       None.
95

APPLICATION USAGE

97       None.
98

RATIONALE

100       None.
101

FUTURE DIRECTIONS

103       None.
104

SEE ALSO

106       posix_trace_attr_init() , posix_trace_create() , posix_trace_get_attr()
107       , uname()  ,  the  Base  Definitions  volume  of  IEEE Std 1003.1-2001,
108       <time.h>, <trace.h>
109

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