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_destroy.3p (4081B)

    

  1. '\" et
  2. .TH POSIX_TRACE_ATTR_DESTROY "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_destroy,
  12. posix_trace_attr_init
  13. \(em destroy and initialize the trace stream attributes object
  14. (\fBTRACING\fP)
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <trace.h>
  19. .P
  20. int posix_trace_attr_destroy(trace_attr_t *\fIattr\fP);
  21. int posix_trace_attr_init(trace_attr_t *\fIattr\fP);
  22. .fi
  23. .SH DESCRIPTION
  24. The
  25. \fIposix_trace_attr_destroy\fR()
  26. function shall destroy an initialized trace attributes object.
  27. A destroyed
  28. .IR attr
  29. attributes object can be reinitialized using
  30. \fIposix_trace_attr_init\fR();
  31. the results of otherwise referencing the object after it
  32. has been destroyed are undefined.
  33. .P
  34. The
  35. \fIposix_trace_attr_init\fR()
  36. function shall initialize a trace attributes object
  37. .IR attr
  38. with the default value for all of the individual attributes used by a
  39. given implementation. The read-only
  40. .IR generation-version
  41. and
  42. .IR clock-resolution
  43. attributes of the newly initialized trace attributes object shall be
  44. set to their appropriate values (see
  45. .IR "Section 2.11.1.2" ", " "posix_trace_status_info Structure").
  46. .P
  47. Results are undefined if
  48. \fIposix_trace_attr_init\fR()
  49. is called specifying an already initialized
  50. .IR attr
  51. attributes object.
  52. .P
  53. Implementations may add extensions to the trace attributes object
  54. structure as permitted in the Base Definitions volume of POSIX.1\(hy2017,
  55. .IR "Chapter 2" ", " "Conformance".
  56. .P
  57. The resulting attributes object (possibly modified by setting
  58. individual attributes values), when used by
  59. \fIposix_trace_create\fR(),
  60. defines the attributes of the trace stream created. A single
  61. attributes object can be used in multiple calls to
  62. \fIposix_trace_create\fR().
  63. After one or more trace streams have been created using an attributes
  64. object, any function affecting that attributes object, including
  65. destruction, shall not affect any trace stream previously created. An
  66. initialized attributes object also serves to receive the attributes of
  67. an existing trace stream or trace log when calling the
  68. \fIposix_trace_get_attr\fR()
  69. function.
  70. .SH "RETURN VALUE"
  71. Upon successful completion, these functions shall return a value of
  72. zero. Otherwise, they shall return the corresponding error number.
  73. .SH ERRORS
  74. The
  75. \fIposix_trace_attr_destroy\fR()
  76. function may fail if:
  77. .TP
  78. .BR EINVAL
  79. The value of
  80. .IR attr
  81. is invalid.
  82. .P
  83. The
  84. \fIposix_trace_attr_init\fR()
  85. function shall fail if:
  86. .TP
  87. .BR ENOMEM
  88. Insufficient memory exists to initialize the trace attributes object.
  89. .LP
  90. .IR "The following sections are informative."
  91. .SH EXAMPLES
  92. None.
  93. .SH "APPLICATION USAGE"
  94. None.
  95. .SH RATIONALE
  96. None.
  97. .SH "FUTURE DIRECTIONS"
  98. The
  99. \fIposix_trace_attr_destroy\fR()
  100. and
  101. \fIposix_trace_attr_init\fR()
  102. functions may be removed in a future version.
  103. .SH "SEE ALSO"
  104. .IR "\fIposix_trace_create\fR\^(\|)",
  105. .IR "\fIposix_trace_get_attr\fR\^(\|)",
  106. .IR "\fIuname\fR\^(\|)"
  107. .P
  108. The Base Definitions volume of POSIX.1\(hy2017,
  109. .IR "\fB<trace.h>\fP"
  110. .\"
  111. .SH COPYRIGHT
  112. Portions of this text are reprinted and reproduced in electronic form
  113. from IEEE Std 1003.1-2017, Standard for Information Technology
  114. -- Portable Operating System Interface (POSIX), The Open Group Base
  115. Specifications Issue 7, 2018 Edition,
  116. Copyright (C) 2018 by the Institute of
  117. Electrical and Electronics Engineers, Inc and The Open Group.
  118. In the event of any discrepancy between this version and the original IEEE and
  119. The Open Group Standard, the original IEEE and The Open Group Standard
  120. is the referee document. The original Standard can be obtained online at
  121. http://www.opengroup.org/unix/online.html .
  122. .PP
  123. Any typographical or formatting errors that appear
  124. in this page are most likely
  125. to have been introduced during the conversion of the source files to
  126. man page format. To report such errors, see
  127. https://www.kernel.org/doc/man-pages/reporting_bugs.html .