proc-get-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: af704f619e3f35940b874459ca7c625308e8968c Maintainer: dams Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id='function.proc-get-status' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>proc_get_status</refname>
  <refpurpose>
   Lit les informations concernant un processus ouvert par <function>proc_open</function>
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>proc_get_status</methodname>
   <methodparam><type>resource</type><parameter>process</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>proc_get_status</function> lit les données concernant le
   processus <parameter>process</parameter> créé avec la fonction
   <function>proc_open</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>process</parameter></term>
     <listitem>
      <para>
       La &resource; <function>proc_open</function> à évaluer.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un tableau contenant les informations collectées.
   Le tableau retourné contient les éléments suivants :
  </para>
  <para>
   <informaltable>
    <tgroup cols="3">
     <thead>
      <row><entry>Élément</entry><entry>Type</entry><entry>Description</entry></row>
     </thead>
     <tbody>
      <row>
       <entry>command</entry>
       <entry>&string;</entry>
       <entry>
        La commande passée à la fonction <function>proc_open</function>.
       </entry>
      </row>
      <row>
       <entry>pid</entry>
       <entry>&integer;</entry>
       <entry>identifiant du processus</entry>
      </row>
      <row>
       <entry>running</entry>
       <entry>&boolean;</entry>
       <entry>
        &true; si le processus fonctionne toujours et 
        &false; s'il est terminé.
       </entry>
      </row>
      <row>
       <entry>signaled</entry>
       <entry>&boolean;</entry>
       <entry>
        &true; si le processus fils a été terminé par un signal inconnu.
        Toujours défini à &false; sous Windows.
       </entry>
      </row>
      <row>
       <entry>stopped</entry>
       <entry>&boolean;</entry>
       <entry>
        &true; si le processus fils a été stoppé par un signal.
        Toujours défini à &false; sous Windows.
       </entry>
      </row>
      <row>
       <entry>exitcode</entry>
       <entry>&integer;</entry>
       <entry>
        Le code retourné par le processus (uniquement si l'élément
        <literal>running</literal> vaut &false;).
        Avant PHP 8.3.0, seule la première appel de cette fonction retournait la vraie valeur, les appels suivants retournaient <literal>-1</literal>.</entry>
     </row>
     <row>
      <entry>mis en cache</entry>
      <entry><type>bool</type></entry>
      <entry>
       À partir de PHP 8.3.0, ceci est &true; lorsque le code de sortie est mis en cache.
       La mise en cache est nécessaire pour s'assurer que le code de sortie n'est pas perdu lors des appels suivants aux API de traitement.
       </entry>
      </row>
      <row>
       <entry>termsig</entry>
       <entry>&integer;</entry>
       <entry>
        le numéro du signal qui a causé la fin de l'exécution du processus fils
        (uniquement significatif si <literal>signaled</literal> vaut &true;).
       </entry>
      </row>
      <row>
       <entry>stopsig</entry>
       <entry>&integer;</entry>
       <entry>
        le numéro du signal qui a causé l'arrêt de l'exécution du processus fils
        (uniquement significatif si <literal>signaled</literal> vaut &true;).
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       L'entrée <literal>"mis en cache"</literal> a été ajoutée au tableau retourné.
       Avant PHP 8.3.0, seule la première appel retournait le vrai code de sortie.
       L'entrée <literal>"mis en cache"</literal> indique que le code de sortie a été mis en cache.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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