logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

posix_trace_attr_getclockres.3p (5789B)


  1. '\" et
  2. .TH POSIX_TRACE_ATTR_GETCLOCKRES "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. posix_trace_attr_getclockres,
  12. posix_trace_attr_getcreatetime,
  13. posix_trace_attr_getgenversion,
  14. posix_trace_attr_getname,
  15. posix_trace_attr_setname
  16. \(em retrieve and set information about a trace stream
  17. (\fBTRACING\fP)
  18. .SH SYNOPSIS
  19. .LP
  20. .nf
  21. #include <time.h>
  22. #include <trace.h>
  23. .P
  24. int posix_trace_attr_getclockres(const trace_attr_t *\fIattr\fP,
  25. struct timespec *\fIresolution\fP);
  26. int posix_trace_attr_getcreatetime(const trace_attr_t *\fIattr\fP,
  27. struct timespec *\fIcreatetime\fP);
  28. .P
  29. #include <trace.h>
  30. .P
  31. int posix_trace_attr_getgenversion(const trace_attr_t *\fIattr\fP,
  32. char *\fIgenversion\fP);
  33. int posix_trace_attr_getname(const trace_attr_t *\fIattr\fP,
  34. char *\fItracename\fP);
  35. int posix_trace_attr_setname(trace_attr_t *\fIattr\fP,
  36. const char *\fItracename\fP);
  37. .fi
  38. .SH DESCRIPTION
  39. The
  40. \fIposix_trace_attr_getclockres\fR()
  41. function shall copy the clock resolution of the clock used to generate
  42. timestamps from the
  43. .IR clock-resolution
  44. attribute of the attributes object pointed to by the
  45. .IR attr
  46. argument into the structure pointed to by the
  47. .IR resolution
  48. argument.
  49. .P
  50. The
  51. \fIposix_trace_attr_getcreatetime\fR()
  52. function shall copy the trace stream creation time from the
  53. .IR creation-time
  54. attribute of the attributes object pointed to by the
  55. .IR attr
  56. argument into the structure pointed to by the
  57. .IR createtime
  58. argument. The
  59. .IR creation-time
  60. attribute shall represent the time of creation of the trace stream.
  61. .P
  62. The
  63. \fIposix_trace_attr_getgenversion\fR()
  64. function shall copy the string containing version information from the
  65. .IR generation-version
  66. attribute of the attributes object pointed to by the
  67. .IR attr
  68. argument into the string pointed to by the
  69. .IR genversion
  70. argument. The
  71. .IR genversion
  72. argument shall be the address of a character array which can store at
  73. least
  74. {TRACE_NAME_MAX}
  75. characters.
  76. .P
  77. The
  78. \fIposix_trace_attr_getname\fR()
  79. function shall copy the string containing the trace name from the
  80. .IR trace-name
  81. attribute of the attributes object pointed to by the
  82. .IR attr
  83. argument into the string pointed to by the
  84. .IR tracename
  85. argument. The
  86. .IR tracename
  87. argument shall be the address of a character array which can store at
  88. least
  89. {TRACE_NAME_MAX}
  90. characters.
  91. .P
  92. The
  93. \fIposix_trace_attr_setname\fR()
  94. function shall set the name in the
  95. .IR trace-name
  96. attribute of the attributes object pointed to by the
  97. .IR attr
  98. argument, using the trace name string supplied by the
  99. .IR tracename
  100. argument. If the supplied string contains more than
  101. {TRACE_NAME_MAX}
  102. characters, the name copied into the
  103. .IR trace-name
  104. attribute may be truncated to one less than the length of
  105. {TRACE_NAME_MAX}
  106. characters. The default value is a null string.
  107. .SH "RETURN VALUE"
  108. Upon successful completion, these functions shall return a value of
  109. zero. Otherwise, they shall return the corresponding error number.
  110. .P
  111. If successful, the
  112. \fIposix_trace_attr_getclockres\fR()
  113. function stores the
  114. .IR clock-resolution
  115. attribute value in the object pointed to by
  116. .IR resolution .
  117. Otherwise, the content of this object is unspecified.
  118. .P
  119. If successful, the
  120. \fIposix_trace_attr_getcreatetime\fR()
  121. function stores the trace stream creation time in the object pointed to
  122. by
  123. .IR createtime .
  124. Otherwise, the content of this object is unspecified.
  125. .P
  126. If successful, the
  127. \fIposix_trace_attr_getgenversion\fR()
  128. function stores the trace version information in the string pointed to
  129. by
  130. .IR genversion .
  131. Otherwise, the content of this string is unspecified.
  132. .P
  133. If successful, the
  134. \fIposix_trace_attr_getname\fR()
  135. function stores the trace name in the string pointed to by
  136. .IR tracename .
  137. Otherwise, the content of this string is unspecified.
  138. .SH ERRORS
  139. The
  140. \fIposix_trace_attr_getclockres\fR(),
  141. \fIposix_trace_attr_getcreatetime\fR(),
  142. \fIposix_trace_attr_getgenversion\fR(),
  143. and
  144. \fIposix_trace_attr_getname\fR()
  145. functions may fail if:
  146. .TP
  147. .BR EINVAL
  148. The value specified by one of the arguments is invalid.
  149. .LP
  150. .IR "The following sections are informative."
  151. .SH EXAMPLES
  152. None.
  153. .SH "APPLICATION USAGE"
  154. None.
  155. .SH RATIONALE
  156. None.
  157. .SH "FUTURE DIRECTIONS"
  158. The
  159. \fIposix_trace_attr_getclockres\fR(),
  160. \fIposix_trace_attr_getcreatetime\fR(),
  161. \fIposix_trace_attr_getgenversion\fR(),
  162. \fIposix_trace_attr_getname\fR(),
  163. and
  164. \fIposix_trace_attr_setname\fR()
  165. functions may be removed in a future version.
  166. .SH "SEE ALSO"
  167. .IR "\fIposix_trace_attr_destroy\fR\^(\|)",
  168. .IR "\fIposix_trace_create\fR\^(\|)",
  169. .IR "\fIposix_trace_get_attr\fR\^(\|)",
  170. .IR "\fIuname\fR\^(\|)"
  171. .P
  172. The Base Definitions volume of POSIX.1\(hy2017,
  173. .IR "\fB<time.h>\fP",
  174. .IR "\fB<trace.h>\fP"
  175. .\"
  176. .SH COPYRIGHT
  177. Portions of this text are reprinted and reproduced in electronic form
  178. from IEEE Std 1003.1-2017, Standard for Information Technology
  179. -- Portable Operating System Interface (POSIX), The Open Group Base
  180. Specifications Issue 7, 2018 Edition,
  181. Copyright (C) 2018 by the Institute of
  182. Electrical and Electronics Engineers, Inc and The Open Group.
  183. In the event of any discrepancy between this version and the original IEEE and
  184. The Open Group Standard, the original IEEE and The Open Group Standard
  185. is the referee document. The original Standard can be obtained online at
  186. http://www.opengroup.org/unix/online.html .
  187. .PP
  188. Any typographical or formatting errors that appear
  189. in this page are most likely
  190. to have been introduced during the conversion of the source files to
  191. man page format. To report such errors, see
  192. https://www.kernel.org/doc/man-pages/reporting_bugs.html .