classptrace.html

pwlib开发文档

</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
End a trace output. If the trace stream output is used outside of the provided macros, the PEndTrace# function must be used at the end of the section of trace output. A mutex is obtained on the call to PBeginTrace# which will prevent any other threads from using the trace stream until the PEndTrace. The PEndTrace# is used in a similar manner to #endl# or #flush#.
<p>
So a typical usage would be: \begin{verbatim} ostream &amp; s = <a class="el" href="classPTrace.html#d8">PTrace::Begin()</a>; s &lt;&lt; "hello"; if (want_there) s &lt;&lt; " there"; s &lt;&lt; '!' &lt;&lt; <a class="el" href="classPTrace.html#d9">PTrace::End()</a>; \end{verbatim} <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>strm</em>&nbsp;</td><td>
Trace output stream being completed </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="d5" doxytag="PTrace::GetLevel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned PTrace::GetLevel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the trace level. The <a class="el" href="object_8h.html#a16">PTRACE()</a> macro checks to see if its level is equal to or lower then the level set by this function. If so then the trace text is output to the trace stream.     </td>
  </tr>
</table>
<a name="d3" doxytag="PTrace::GetOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned PTrace::GetOptions </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the current trace options. The <a class="el" href="object_8h.html#a16">PTRACE()</a>, <a class="el" href="object_8h.html#a14">PTRACE_BLOCK()</a> and <a class="el" href="object_8h.html#a15">PTRACE_LINE()</a> macros output trace text that may contain assorted values. These are defined by the Options enum.     </td>
  </tr>
</table>
<a name="d0" doxytag="PTrace::Initialise"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PTrace::Initialise </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>level</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>filename</em> = NULL, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>unsigned&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>options</em> = Timestamp|Thread|Blocks</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the most common trace options. If filename is not NULL then a <a class="el" href="classPTextFile.html">PTextFile</a> is created and attached the trace output stream. This object is never closed or deleted until the termination of the program.
<p>
A trace output of the program name version and OS is written as well.     </td>
  </tr>
</table>
<a name="d4" doxytag="PTrace::SetLevel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PTrace::SetLevel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>level</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the trace level. The <a class="el" href="object_8h.html#a16">PTRACE()</a> macro checks to see if its level is equal to or lower then the level set by this function. If so then the trace text is output to the trace stream. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>level</em>&nbsp;</td><td>
New level for trace </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="d1" doxytag="PTrace::SetOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PTrace::SetOptions </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>options</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the trace options. The <a class="el" href="object_8h.html#a16">PTRACE()</a>, <a class="el" href="object_8h.html#a14">PTRACE_BLOCK()</a> and <a class="el" href="object_8h.html#a15">PTRACE_LINE()</a> macros output trace text that may contain assorted values. These are defined by the Options enum.
<p>
Note this function OR's the bits included in the options parameter. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>options</em>&nbsp;</td><td>
New level for trace </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="d7" doxytag="PTrace::SetStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PTrace::SetStream </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">ostream *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>out</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the stream to be used for trace output. This stream is used for all trace output using the various trace functions and macros. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>out</em>&nbsp;</td><td>
New output stream from trace. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="object_8h-source.html">object.h</a></ul>
<hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:20 2004 for PWLib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>