classppipechannel.html

pwlib开发文档

  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine if the program associated with the PPipeChannel is still executing. This is useful for determining the status of PPipeChannels which take a long time to execute on operating systems which support concurrent multi-processing.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the program associated with the PPipeChannel is still running </dl>    </td>
  </tr>
</table>
<a name="z219_10" doxytag="PPipeChannel::Kill"></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"> BOOL PPipeChannel::Kill </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>signal</em> = 9          </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>
This function will terminate the sub-program using the signal code specified.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the process received the signal. Note that this does not mean that the process has actually terminated. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>signal</em>&nbsp;</td><td>
Signal code to be sent to process. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z219_3" doxytag="PPipeChannel::Open"></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"> BOOL PPipeChannel::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>subProgram</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPStringArray.html">PStringArray</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>argumentList</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPStringToString.html">PStringToString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>environment</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPPipeChannel.html#z213_0">OpenMode</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>mode</em> = ReadWrite, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>searchPath</em> = TRUE, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>stderrSeparate</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

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

<p>
Open a new pipe channel allowing the subProgram to be executed and data transferred from its stdin/stdout/stderr.
<p>
If the mode is <a class="el" href="classPPipeChannel.html#z213_0s0">ReadOnly</a># then the stdout# of the sub-program is supplied via the <a class="el" href="classPPipeChannel.html#z217_1">Read()</a># calls of the PPipeChannel. The sub-programs input is set to the platforms null device (eg /dev/nul).
<p>
If mode is <a class="el" href="classPPipeChannel.html#z213_0s1">WriteOnly</a># then <a class="el" href="classPPipeChannel.html#z217_2">Write()</a># calls of the PPipeChannel are suppied to the sub-programs stdin# and its stdout# is sent to the null device.
<p>
If mode is <a class="el" href="classPPipeChannel.html#z213_0s2">ReadWrite</a># then both read and write actions can occur.
<p>
The subProgram# parameter may contain just the path of the program to be run or a program name and space separated arguments, similar to that provided to the platforms command processing shell. Which use of this parameter is determiend by whether arguments are passed via the argumentPointers# or argumentList# parameters.
<p>
The searchPath# parameter indicates that the system PATH for executables should be searched for the sub-program. If FALSE then only the explicit or implicit path contained in the subProgram# parameter is searched for the executable.
<p>
The stderrSeparate# parameter indicates that the standard error stream is not included in line with the standard output stream. In this case, data in this stream must be read using the <a class="el" href="classPPipeChannel.html#z219_11">ReadStandardError()</a># function.
<p>
The environment# parameter is a null terminated sequence of null terminated strings of the form name=value. If NULL is passed then the same invironment as calling process uses is passed to the child process. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>argumentList</em>&nbsp;</td><td>
Sub program name or command line. </td></tr>
<tr><td valign=top><em>environment</em>&nbsp;</td><td>
Array of arguments to sub-program. </td></tr>
<tr><td valign=top><em>mode</em>&nbsp;</td><td>
Array of arguments to sub-program. </td></tr>
<tr><td valign=top><em>searchPath</em>&nbsp;</td><td>
Mode for the pipe channel. </td></tr>
<tr><td valign=top><em>stderrSeparate</em>&nbsp;</td><td>
Flag for system PATH to be searched. Standard error is on separate pipe </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z219_2" doxytag="PPipeChannel::Open"></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"> BOOL PPipeChannel::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>subProgram</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPStringToString.html">PStringToString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>environment</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPPipeChannel.html#z213_0">OpenMode</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>mode</em> = ReadWrite, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>searchPath</em> = TRUE, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>stderrSeparate</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

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

<p>
Open a channel. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>environment</em>&nbsp;</td><td>
Sub program name or command line. </td></tr>
<tr><td valign=top><em>mode</em>&nbsp;</td><td>
Array of arguments to sub-program. </td></tr>
<tr><td valign=top><em>searchPath</em>&nbsp;</td><td>
Mode for the pipe channel. </td></tr>
<tr><td valign=top><em>stderrSeparate</em>&nbsp;</td><td>
Flag for system PATH to be searched. Standard error is on separate pipe </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z219_1" doxytag="PPipeChannel::Open"></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"> BOOL PPipeChannel::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>subProgram</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPStringArray.html">PStringArray</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>argumentList</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPPipeChannel.html#z213_0">OpenMode</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>mode</em> = ReadWrite, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>searchPath</em> = TRUE, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>stderrSeparate</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

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

<p>
Open a channel. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>argumentList</em>&nbsp;</td><td>
Sub program name or command line. </td></tr>
<tr><td valign=top><em>mode</em>&nbsp;</td><td>
Array of arguments to sub-program. </td></tr>
<tr><td valign=top><em>searchPath</em>&nbsp;</td><td>
Mode for the pipe channel. </td></tr>
<tr><td valign=top><em>stderrSeparate</em>&nbsp;</td><td>
Flag for system PATH to be searched. Standard error is on separate pipe </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z219_0" doxytag="PPipeChannel::Open"></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"> BOOL PPipeChannel::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>subProgram</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPPipeChannel.html#z213_0">OpenMode</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>mode</em> = ReadWrite, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>searchPath</em> = TRUE, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>stderrSeparate</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

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

<p>
Open a channel. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>mode</em>&nbsp;</td><td>
Sub program name or command line. </td></tr>
<tr><td valign=top><em>searchPath</em>&nbsp;</td><td>
Mode for the pipe channel. </td></tr>
<tr><td valign=top><em>stderrSeparate</em>&nbsp;</td><td>
Flag for system PATH to be searched. Standard error is on separate pipe </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z217_1" doxytag="PPipeChannel::Read"></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 PPipeChannel::Read </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>buf</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>PINDEX&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>len</em></td>