<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.28 -->
<refentry xml:id='function.proc-close' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>proc_close</refname>
  <refpurpose>Close a process opened by <function>proc_open</function> and return the exit code of that process</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>proc_close</methodname>
   <methodparam><type>resource</type><parameter>process</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>proc_close</function> is similar to <function>pclose</function>
   except that it only works on processes opened by
   <function>proc_open</function>.
   <function>proc_close</function> waits for the process to terminate, and
   returns its exit code.  If you have open pipes to that process, you
   should <function>fclose</function> them prior to calling this function in
   order to avoid a deadlock - the child process may not be able to exit
   while the pipes are open.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>process</parameter></term>
     <listitem>
      <para>
       The <function>proc_open</function> <type>resource</type> that will
       be closed.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the termination status of the process that was run. In case of 
   an error then <literal>-1</literal> is returned.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Unix Only:</title>
   <para>
    <function>proc_close</function> is internally implemented using the 
    <literal>waitpid(3)</literal> system call. To obtain the real exit 
    status code the <function>pcntl_wexitstatus</function> function 
    should be used.
   </para>
  </note>
 </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:"~/.phpdoc/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
-->