posix_trace_attr_init(3p)

1POSIX_TRACE_ATTR_DESTROY(3P)POSIX Programmer's ManuaPlOSIX_TRACE_ATTR_DESTROY(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_destroy, posix_trace_attr_init - destroy and  initial‐
13       ize the trace stream attributes object (TRACING)
14

SYNOPSIS

16       #include <trace.h>
17
18       int posix_trace_attr_destroy(trace_attr_t *attr);
19       int posix_trace_attr_init(trace_attr_t *attr);
20
21

DESCRIPTION

23       The  posix_trace_attr_destroy()  function  shall destroy an initialized
24       trace attributes object. A destroyed  attr  attributes  object  can  be
25       reinitialized  using  posix_trace_attr_init(); the results of otherwise
26       referencing the object after it has been destroyed are undefined.
27
28       The  posix_trace_attr_init()  function   shall   initialize   a   trace
29       attributes object attr with the default value for all of the individual
30       attributes used by a given implementation.  The  read-only  generation-
31       version  and clock-resolution attributes of the newly initialized trace
32       attributes object shall be set to their appropriate values  (see  Trace
33       Stream Attributes ).
34
35       Results  are  undefined if posix_trace_attr_init() is called specifying
36       an already initialized attr attributes object.
37
38       Implementations may add  extensions  to  the  trace  attributes  object
39       structure   as   permitted   in   the   Base   Definitions   volume  of
40       IEEE Std 1003.1-2001, Chapter 2, Conformance.
41
42       The resulting attributes object (possibly modified by setting  individ‐
43       ual  attributes values), when used by posix_trace_create(), defines the
44       attributes of the trace stream created. A single attributes object  can
45       be  used  in multiple calls to posix_trace_create().  After one or more
46       trace streams have been created using an attributes object,  any  func‐
47       tion affecting that attributes object, including destruction, shall not
48       affect any trace stream previously created. An  initialized  attributes
49       object  also  serves  to  receive  the  attributes of an existing trace
50       stream or trace log when calling the posix_trace_get_attr() function.
51

RETURN VALUE

53       Upon successful completion, these functions shall  return  a  value  of
54       zero. Otherwise, they shall return the corresponding error number.
55

ERRORS

57       The posix_trace_attr_destroy() function may fail if:
58
59       EINVAL The value of attr is invalid.
60
61
62       The posix_trace_attr_init() function shall fail if:
63
64       ENOMEM Insufficient  memory  exists  to initialize the trace attributes
65              object.
66
67
68       The following sections are informative.
69

EXAMPLES

71       None.
72

APPLICATION USAGE

74       None.
75

RATIONALE

77       None.
78

FUTURE DIRECTIONS

80       None.
81

COPYRIGHT

87       Portions  of  this text are reprinted and reproduced in electronic form
88       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
89       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
90       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
91       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
92       event of any discrepancy between this version and the original IEEE and
93       The  Open Group Standard, the original IEEE and The Open Group Standard
94       is the referee document. The original Standard can be  obtained  online
95       at http://www.opengroup.org/unix/online.html .
96
97
98
99IEEE/The Open Group                  2003         POSIX_TRACE_ATTR_DESTROY(3P)