doc-en/reference/curl/functions/curl-multi-remove-handle.xml at master · php/doc-en · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.curl-multi-remove-handle" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_multi_remove_handle</refname>
  <refpurpose>Remove a handle from a set of cURL handles</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>curl_multi_remove_handle</methodname>
   <methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
   <methodparam><type>CurlHandle</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Removes a given <parameter>handle</parameter> from the given <parameter>multi_handle</parameter>.
   When the <parameter>handle</parameter> has been removed, it is again perfectly
   legal to run <function>curl_exec</function> on this handle.  Removing the <parameter>handle</parameter> while being
   used, will effectively halt the transfer in progress involving that handle.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.mh.description;
    &curl.ch.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns 0 on success, or one of the <constant>CURLM_<replaceable>*</replaceable></constant> error
   codes.
  </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;
     &curl.changelog.handle-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>curl_init</function></member>
    <member><function>curl_multi_init</function></member>
    <member><function>curl_multi_add_handle</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
-->