classpchannel.html

pwlib开发文档

    </td>
  </tr>
</table>
<a name="z53_0" doxytag="PChannel::ShutdownValue"></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"> enum PChannel::ShutdownValue
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="z53_0s0" doxytag="ShutdownRead"></a><em>ShutdownRead</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="z53_0s1" doxytag="ShutdownWrite"></a><em>ShutdownWrite</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="z53_0s2" doxytag="ShutdownReadAndWrite"></a><em>ShutdownReadAndWrite</em></em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="z43_0" doxytag="PChannel::PChannel"></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"> PChannel::PChannel </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></td>
        </tr>

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

<p>
Create the channel.
<p>
    </td>
  </tr>
</table>
<a name="z43_1" doxytag="PChannel::~PChannel"></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"> PChannel::~PChannel </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></td>
        </tr>

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

<p>
Close down the channel.
<p>
    </td>
  </tr>
</table>
<a name="b0" doxytag="PChannel::PChannel"></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"> PINLINE PChannel::PChannel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const PChannel &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected]</code></td>
        </tr>

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

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="z53_5" doxytag="PChannel::AbortCommandString"></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"> PINLINE void PChannel::AbortCommandString </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></td>
        </tr>

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

<p>
Abort a command string that is in progress. Note that as the <a class="el" href="classPChannel.html#z53_4">SendCommandString()</a> function blocks the calling thread when it runs, this can only be called from within another thread.     </td>
  </tr>
</table>
<a name="z53_1" doxytag="PChannel::Close"></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"> virtual BOOL PChannel::Close </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> [virtual]</code></td>
        </tr>

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

<p>
Close the channel, shutting down the link to the data source.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
TRUE if the channel successfully closed. </dl>
<p>
Reimplemented in <a class="el" href="classPConsoleChannel.html#a1">PConsoleChannel</a>, <a class="el" href="classPEthSocket.html#z115_0">PEthSocket</a>, <a class="el" href="classPFile.html#z129_3">PFile</a>, <a class="el" href="classPIndirectChannel.html#z157_1">PIndirectChannel</a>, <a class="el" href="classPPipeChannel.html#z217_3">PPipeChannel</a>, <a class="el" href="classPSerialChannel.html#a0">PSerialChannel</a>, <a class="el" href="classPVideoChannel.html#a21">PVideoChannel</a>, <a class="el" href="classPFTPClient.html#z479_0">PFTPClient</a>, <a class="el" href="classPSMTPClient.html#a2">PSMTPClient</a>, <a class="el" href="classPPOP3Client.html#a2">PPOP3Client</a>, <a class="el" href="classPRFC822Channel.html#a2">PRFC822Channel</a>, <a class="el" href="classPModem.html#a3">PModem</a>, <a class="el" href="classPSSLChannel.html#a5">PSSLChannel</a>, <a class="el" href="classPWAVFile.html#z495_4">PWAVFile</a>, <a class="el" href="classPQueueChannel.html#z501_2">PQueueChannel</a>, <a class="el" href="classPVXMLSession.html#a13">PVXMLSession</a>, and <a class="el" href="classPVXMLChannel.html#a4">PVXMLChannel</a>.    </td>
  </tr>
</table>
<a name="z45_0" doxytag="PChannel::Compare"></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"> virtual <a class="el" href="classPObject.html#z199_0">Comparison</a> PChannel::Compare </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPObject.html">PObject</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>obj</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>

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

<p>
Get the relative rank of the two strings. The system standard function, eg strcmp(), is used.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 comparison of the two objects, <a class="el" href="classPObject.html#z199_0s1">EqualTo</a># for same, <a class="el" href="classPObject.html#z199_0s0">LessThan</a># for obj# logically less than the object and <a class="el" href="classPObject.html#z199_0s2">GreaterThan</a># for obj# logically greater than the object. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>obj</em>&nbsp;</td><td>
Other <a class="el" href="classPString.html">PString</a> to compare against. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPObject.html#z199_1">PObject</a>.
<p>
Reimplemented in <a class="el" href="classPFile.html#z127_0">PFile</a>, <a class="el" href="classPIndirectChannel.html#z155_0">PIndirectChannel</a>, <a class="el" href="classPPipeChannel.html#z215_0">PPipeChannel</a>, and <a class="el" href="classPMemoryFile.html#z485_0">PMemoryFile</a>.    </td>
  </tr>
</table>
<a name="b2" doxytag="PChannel::ConvertOSError"></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"> virtual BOOL PChannel::ConvertOSError </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>libcReturnValue</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPChannel.html#z55_1">ErrorGroup</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>group</em> = LastGeneralError</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected, virtual]</code></td>
        </tr>

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

<p>
Convert an operating system error into platform independent error. The internal error codes are set by this function. They may be obtained via the <a class="el" href="classPChannel.html#z55_2">GetErrorCode()</a># and <a class="el" href="classPChannel.html#z55_3">GetErrorNumber()</a># functions.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
TRUE if there was no error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>group</em>&nbsp;</td><td>
Error group to set </td></tr>
</table>
</dl>
<p>