Source of: /manual/en/function.curl-multi-info-read.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = 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',
),
'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',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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)</p><p class="refpurpose"><span class="refname">curl_multi_info_read</span> — <span class="dc-title">Get information about the current transfers</span></p>
</div>
<a name="function.curl-multi-info-read.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>curl_multi_info_read</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$mh</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter reference">&$msgs_in_queue</tt><span class="initializer"> = NULL</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 <b><tt class="constant">FALSE</tt></b> is returned
as a signal that there is no more to get at this point. The integer pointed to with
<i><tt class="parameter">msgs_in_queue</tt></i>
will contain the number of remaining messages after this
function was called.
</p>
<div class="warning"><b class="warning">Warning</b>
<p class="para">
The data the returned resource points to will not survive calling
<a href="function.curl-multi-remove-handle.php" class="function">curl_multi_remove_handle()</a>.
</p>
</div>
</div>
<a name="function.curl-multi-info-read.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mh</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">A cURL multi handle returned by
<a href="function.curl-multi-init.php" class="function">curl_multi_init()</a>.</p></dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">msgs_in_queue</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Number of messages that are still in the queue
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.curl-multi-info-read.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, returns an associative array for the message, <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.curl-multi-info-read.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">5.2.0</td>
<td align="left">
<i><tt class="parameter">msgs_in_queue</tt></i>
was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.curl-multi-info-read.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.curl-multi-init.php" class="function" rel="rdfs-seeAlso">curl_multi_init()</a> - Returns a new cURL multi handle</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
