<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.curl.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.curl-multi-info-read.php',
    1 => 'curl_multi_info_read',
    2 => 'Get information about the current transfers',
  ),
  'up' => 
  array (
    0 => 'ref.curl.php',
    1 => 'cURL Functions',
  ),
  'prev' => 
  array (
    0 => 'function.curl-multi-getcontent.php',
    1 => 'curl_multi_getcontent',
  ),
  'next' => 
  array (
    0 => 'function.curl-multi-init.php',
    1 => 'curl_multi_init',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/curl/functions/curl-multi-info-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.curl-multi-info-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">curl_multi_info_read</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">curl_multi_info_read</span> &mdash; <span class="dc-title">Get information about the current transfers</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.curl-multi-info-read-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>curl_multi_info_read</strong></span>(<span class="methodparam"><span class="type"><a href="class.curlmultihandle.php" class="type CurlMultiHandle">CurlMultiHandle</a></span> <code class="parameter">$multi_handle</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter reference">&$queued_messages</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Ask the multi handle if there are any messages or information from the individual transfers. 
   Messages may include information such as an error code from the transfer or just the fact 
   that a transfer is completed.
  </p>
  <p class="para">   
   Repeated calls to this function will return a new result each time, until a <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> is returned 
   as a signal that there is no more to get at this point. The integer pointed to with 
   <code class="parameter">queued_messages</code> will contain the number of remaining messages after this 
   function was called.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    The data the returned resource points to will not survive calling 
    <span class="function"><a href="function.curl-multi-remove-handle.php" class="function">curl_multi_remove_handle()</a></span>.
   </p>
  </div>
 </div>

 
 <div class="refsect1 parameters" id="refsect1-function.curl-multi-info-read-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    <dt><code class="parameter">multi_handle</code>
</dt><dd><p class="para">A cURL multi handle returned by
<span class="function"><a href="function.curl-multi-init.php" class="function">curl_multi_init()</a></span>.</p></dd>
    
     <dt><code class="parameter">queued_messages</code></dt>
     <dd>
      <p class="para">
       Number of messages that are still in the queue
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 
 <div class="refsect1 returnvalues" id="refsect1-function.curl-multi-info-read-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   On success, returns an associative array for the message, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Contents of the returned array</strong></caption>
    
     <thead>
      <tr>
       <th>Key:</th>
       <th>Value:</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">msg</code></td>
       <td>The <strong><code><a href="curl.constants.php#constant.curlmsg-done">CURLMSG_DONE</a></code></strong> constant. Other return values
       are currently not available.</td>
      </tr>

      <tr>
       <td><code class="literal">result</code></td>
       <td>One of the <strong><code><a href="curl.constants.php#constant.curle-aborted-by-callback">CURLE_<span class="replaceable">*</span></a></code></strong> constants. If everything is
       OK, the <strong><code><a href="curl.constants.php#constant.curle-ok">CURLE_OK</a></code></strong> will be the result.</td>
      </tr>

      <tr>
       <td><code class="literal">handle</code></td>
       <td>Resource of type curl indicates the handle which it concerns.</td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.curl-multi-info-read-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.0.0</td>
 <td>
  <code class="parameter">multi_handle</code> expects a <span class="classname"><a href="class.curlmultihandle.php" class="classname">CurlMultiHandle</a></span>
  instance now; previously, a <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> was expected.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.curl-multi-info-read-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.curl-multi-init.php" class="function" rel="rdfs-seeAlso">curl_multi_init()</a> - Returns a new cURL multi handle</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>