pcntl-get-last-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.pcntl-get-last-error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>pcntl_get_last_error</refname>
  <refpurpose>Retrieve the error number set by the last pcntl function which failed</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pcntl_get_last_error</methodname>
   <void />
  </methodsynopsis>
  <para>
   Retrieve the error number (<literal>errno</literal>) set by the last
   pcntl function that failed. The system error message associated with
   the error number may be checked with <function>pcntl_strerror</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the error number (<literal>errno</literal>) set by the last
   pcntl function that failed.  If there was no error, 0 is returned.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>pcntl_get_last_error</function> example</title>
   <para>
    This example will attempt to wait on child processes
    in a situation where no child process exists,
    then will print out the corresponding error message.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$pid = pcntl_wait($status);
if ($pid === -1) {
    $errno = pcntl_get_last_error();
    $message = pcntl_strerror($errno);
    fwrite(STDERR, 'pcntl_wait failed with errno ' . $errno
           . ': ' . $message . PHP_EOL);
}
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
pcntl_wait failed with errno 10: No child processes
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>pcntl_strerror</function></member>
  </simplelist>
 </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
-->