1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.curl-multi-info-read" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>curl_multi_info_read</refname>
<refpurpose>Get information about the current transfers</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>curl_multi_info_read</methodname>
<methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">queued_messages</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
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.
</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>queued_messages</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>queued_messages</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>
<para>
<table>
<title>Contents of the returned array</title>
<tgroup cols="2">
<thead>
<row>
<entry>Key:</entry>
<entry>Value:</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>msg</literal></entry>
<entry>The <constant>CURLMSG_DONE</constant> constant. Other return values
are currently not available.</entry>
</row>
<row>
<entry><literal>result</literal></entry>
<entry>One of the <constant>CURLE_<replaceable>*</replaceable></constant> constants. If everything is
OK, the <constant>CURLE_OK</constant> will be the result.</entry>
</row>
<row>
<entry><literal>handle</literal></entry>
<entry>Resource of type curl indicates the handle which it concerns.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&curl.changelog.multi-handle-param;
</tbody>
</tgroup>
</informaltable>
</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:"~/.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
-->
|
