[PHP-DOC] cvs: phpdoc /en/reference/exec/functions proc-get-status.xml

[Hartmut Holzgraefe]

hholzgra                Sun Feb  9 19:44:18 2003 EDT

  Added files:                 
    /phpdoc/en/reference/exec/functions proc-get-status.xml 
  Log:
  proc_get_status() mostly documented
  
  

Index: phpdoc/en/reference/exec/functions/proc-get-status.xml
+++ phpdoc/en/reference/exec/functions/proc-get-status.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
  <refentry id='function.proc-get-status'>
   <refnamediv>
    <refname>proc_get_status</refname>
    <refpurpose>
     Get information about a process opened by <function>proc_open</function>
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>proc_get_status</methodname>
      <methodparam><type>resource</type><parameter>process</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>proc_get_status</function> fetches data about a
     process opened using <function>proc_open</function>. The
     collected information is returned in an array containing the
     following elements:
    </para>
    <informaltable>
     <tgroup cols="3">
      <thead>
       <row><entry>element</entry><entry>type</entry><entry>description</entry></row>
      </thead>
      <tbody>
       <row>
        <entry>command</entry>
        <entry>string</entry>
        <entry></entry>
       </row>
       <row>
        <entry>pid</entry>
        <entry>int</entry>
        <entry>process id</entry>
       </row>
       <row>
        <entry>running</entry>
        <entry>bool</entry>
        <entry>
         &true; if the process is still running, &false; if it has
         terminated
        </entry>
       </row>
       <row>
        <entry>signaled</entry>
        <entry>bool</entry>
        <entry>TODO</entry>
       </row>
       <row>
        <entry>stopper</entry>
        <entry>bool</entry>
        <entry>TODO</entry>
       </row>
       <row>
        <entry>exitcode</entry>
        <entry>int</entry>
        <entry>
         the exit code returned by the process (which is only
         meaningfull if running is &false;
        </entry>
       </row>
       <row>
        <entry>termsig</entry>
        <entry>int</entry>
        <entry>TODO</entry>
       </row>
       <row>
        <entry>stopsig</entry>
        <entry>int</entry>
        <entry>TODO</entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->



-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php