curl-multi-info-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: mowangjuanzi Status: ready -->
<!-- CREDITS: Luffy -->
<refentry xml:id="function.curl-multi-info-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_multi_info_read</refname>
  <refpurpose>获取当前传输的有关信息</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>
   查询多句柄是否有来自个别传输的消息或信息，消息可能包含诸如来自传输的错误代码或者仅是传输已完成之类的信息。
  </para>
  <para>
   重复调用此函数，每次都会返回新结果，返回 &false; 作为此时没有更多信息可以获取的信号。通过
   <parameter>queued_messages</parameter> 返回的整数包含当前函数调用后剩余的消息数量。
  </para>
  <warning>
   <para>
    返回的资源指向的数据将无法在调用 <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>
       仍在队列中的消息数量。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功时返回信息的关联数组，失败时返回 &false;。
  </para>
  <para>
   <table>
    <title>返回数组的内容</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Key:</entry>
       <entry>Value:</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>msg</literal></entry>
       <entry><constant>CURLMSG_DONE</constant> 常量。其他返回值当前不可用。</entry>
      </row>
      <row>
       <entry><literal>result</literal></entry>
       <entry><constant>CURLE_<replaceable>*</replaceable></constant> 常量之一。如果一切都好，将会返回 <constant>CURLE_OK</constant>。</entry>
      </row>
      <row>
       <entry><literal>handle</literal></entry>
       <entry>cURL 资源类型表明它有关的句柄。</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
-->