php-doc-en/reference/curl/functions/curl-multi-info-read.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.curl-multi-info-read">
 <refnamediv>
  <refname>curl_multi_info_read</refname>
  <refpurpose>Get information about the current transfers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>curl_multi_info_read</methodname>
   <methodparam><type>resource</type><parameter>mh</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>msgs_in_queue</parameter></methodparam>
  </methodsynopsis>
  <para>
   Ask the multi handle if there are any messages/informationals from the individual transfers. 
   Messages may include informationals such as an error code from the transfer or just the fact 
   that a transfer is completed.
  </para>
  <para>   
   Repeated calls to this function will return a new result each time, until a &false; is returned 
   as a signal that there is no more to get at this point. The integer pointed to with 
   <parameter>msgs_in_queue</parameter> will contain the number of remaining messages after this 
   function was called.
  </para>
  <warning>
   <para>
    The data the returned resource points to will not survive calling 
    <function>curl_multi_remove_handle</function>.
   </para>
  </warning>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.mh.description;
    <varlistentry>
     <term><parameter>msgs_in_queue</parameter></term>
     <listitem>
      <para>
       Number of messages that are still in the queue
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success, returns an associative array for the message, &false; on failure.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.2.0</entry>
       <entry>
        <parameter>msgs_in_queue</parameter> was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>curl_multi_init</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:"../../../../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
-->