162 lines
6.5 KiB
HTML
162 lines
6.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>posix_trace_get_attr</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="posix_trace_get_attr"></a> <a name="tag_03_469"></a><!-- posix_trace_get_attr -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_469_01"></a>NAME</h4>
|
|
|
|
<blockquote>posix_trace_get_attr, posix_trace_get_status - retrieve the trace attributes or trace status
|
|
(<b>TRACING</b>)</blockquote>
|
|
|
|
<h4><a name="tag_03_469_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<div class="box"><code><tt><sup>[<a href="javascript:open_code('TRC')">TRC</a>]</sup> <img src="../images/opt-start.gif" alt=
|
|
"[Option Start]" border="0"> #include <<a href="../basedefs/trace.h.html">trace.h</a>><br>
|
|
<br>
|
|
int posix_trace_get_attr(trace_id_t</tt> <i>trid</i><tt>, trace_attr_t *</tt><i>attr</i><tt>);<br>
|
|
int posix_trace_get_status(trace_id_t</tt> <i>trid</i><tt>,<br>
|
|
struct posix_trace_status_info *</tt><i>statusinfo</i><tt>); <img src="../images/opt-end.gif"
|
|
alt="[Option End]" border="0"></tt></code></div>
|
|
|
|
<tt><br>
|
|
</tt></blockquote>
|
|
|
|
<h4><a name="tag_03_469_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>posix_trace_get_attr</i>() function shall copy the attributes of the active trace stream identified by <i>trid</i> into
|
|
the object pointed to by the <i>attr</i> argument. <sup>[<a href="javascript:open_code('TRL')">TRL</a>]</sup> <img src=
|
|
"../images/opt-start.gif" alt="[Option Start]" border="0"> If the Trace Log option is supported, <i>trid</i> may represent a
|
|
pre-recorded trace log. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></p>
|
|
|
|
<p>The <i>posix_trace_get_status</i>() function shall return, in the structure pointed to by the <i>statusinfo</i> argument, the
|
|
current trace status for the trace stream identified by the <i>trid</i> argument. These status values returned in the structure
|
|
pointed to by <i>statusinfo</i> shall have been appropriately read to ensure that the returned values are consistent. <sup>[<a
|
|
href="javascript:open_code('TRL')">TRL</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> If the
|
|
Trace Log option is supported and the <i>trid</i> argument refers to a pre-recorded trace stream, the status shall be the status of
|
|
the completed trace stream. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></p>
|
|
|
|
<p>Each time the <i>posix_trace_get_status</i>() function is used, the overrun status of the trace stream shall be reset to
|
|
POSIX_TRACE_NO_OVERRUN immediately after the call completes. <sup>[<a href="javascript:open_code('TRL')">TRL</a>]</sup> <img src=
|
|
"../images/opt-start.gif" alt="[Option Start]" border="0"> If the Trace Log option is supported, the
|
|
<i>posix_trace_get_status</i>() function shall behave the same as when the option is not supported except for the following
|
|
differences:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>If the <i>trid</i> argument refers to a trace stream with log, each time the <i>posix_trace_get_status</i>() function is used,
|
|
the log overrun status of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN and the <i>flush_error</i> status shall be
|
|
reset to zero immediately after the call completes.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>If the <i>trid</i> argument refers to a pre-recorded trace stream, the status returned shall be the status of the completed
|
|
trace stream and the status values of the trace stream shall not be reset.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<img src="../images/opt-end.gif" alt="[Option End]" border="0"></blockquote>
|
|
|
|
<h4><a name="tag_03_469_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>Upon successful completion, these functions shall return a value of zero. Otherwise, they shall return the corresponding error
|
|
number.</p>
|
|
|
|
<p>The <i>posix_trace_get_attr</i>() function stores the trace attributes in the object pointed to by <i>attr</i>, if
|
|
successful.</p>
|
|
|
|
<p>The <i>posix_trace_get_status</i>() function stores the trace status in the object pointed to by <i>statusinfo</i>, if
|
|
successful.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>These functions shall fail if:</p>
|
|
|
|
<dl compact>
|
|
<dt>[EINVAL]</dt>
|
|
|
|
<dd>The trace stream argument <i>trid</i> does not correspond to a valid active trace stream or a valid trace log.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_469_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="posix_trace_attr_destroy.html"><i>posix_trace_attr_destroy</i>()</a> , <a href=
|
|
"posix_trace_attr_init.html"><i>posix_trace_attr_init</i>()</a> , <a href="posix_trace_create.html"><i>posix_trace_create</i>()</a>
|
|
, <a href="posix_trace_open.html"><i>posix_trace_open</i>()</a> , the Base Definitions volume of IEEE Std 1003.1-2001, <a
|
|
href="../basedefs/trace.h.html"><i><trace.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_469_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 6. Derived from IEEE Std 1003.1q-2000.</p>
|
|
|
|
<p>IEEE PASC Interpretation 1003.1 #123 is applied.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|