Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/posix_trace_start.html
2024-02-19 00:21:47 -05:00

139 lines
4.9 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_start</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="posix_trace_start"></a> <a name="tag_03_476"></a><!-- posix_trace_start -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_476_01"></a>NAME</h4>
<blockquote>posix_trace_start, posix_trace_stop - trace start and stop (<b>TRACING</b>)</blockquote>
<h4><a name="tag_03_476_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 &lt;<a href="../basedefs/trace.h.html">trace.h</a>&gt;<br>
<br>
int posix_trace_start(trace_id_t</tt> <i>trid</i><tt>);<br>
int posix_trace_stop (trace_id_t</tt> <i>trid</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_476_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>posix_trace_start</i>() and <i>posix_trace_stop</i>() functions, respectively, shall start and stop the trace stream
identified by the argument <i>trid</i>.</p>
<p>The effect of calling the <i>posix_trace_start</i>() function shall be recorded in the trace stream as the POSIX_TRACE_START
system trace event and the status of the trace stream shall become POSIX_TRACE_RUNNING. If the trace stream is in progress when
this function is called, the POSIX_TRACE_START system trace event shall not be recorded and the trace stream shall continue to run.
If the trace stream is full, the POSIX_TRACE_START system trace event shall not be recorded and the status of the trace stream
shall not be changed.</p>
<p>The effect of calling the <i>posix_trace_stop</i>() function shall be recorded in the trace stream as the POSIX_TRACE_STOP
system trace event and the status of the trace stream shall become POSIX_TRACE_SUSPENDED. If the trace stream is suspended when
this function is called, the POSIX_TRACE_STOP system trace event shall not be recorded and the trace stream shall remain suspended.
If the trace stream is full, the POSIX_TRACE_STOP system trace event shall not be recorded and the status of the trace stream shall
not be changed.</p>
</blockquote>
<h4><a name="tag_03_476_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>
</blockquote>
<h4><a name="tag_03_476_05"></a>ERRORS</h4>
<blockquote>
<p>These functions shall fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value of the argument <i>trid</i> does not correspond to an active trace stream and thus no trace stream was started or
stopped.</dd>
<dt>[EINTR]</dt>
<dd>The operation was interrupted by a signal and thus the trace stream was not necessarily started or stopped.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_476_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_476_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_476_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_476_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_476_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="posix_trace_create.html"><i>posix_trace_create</i>()</a> , the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/trace.h.html"><i>&lt;trace.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_476_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 6. Derived from IEEE&nbsp;Std&nbsp;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 &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; 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>