php-doc-en/reference/curl/functions/curl-multi-remove-handle.xml
Christoph Michael Becker b7f8c11e56 Generate curl methodsynopses based on stubs
Amended by cmb.

Closes GH-231.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351621 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-25 00:58:58 +00:00

91 lines
2.5 KiB
XML

<?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 multi 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> handle from the given <parameter>multi_handle</parameter>
handle. When the <parameter>handle</parameter> handle has been removed, it is again perfectly
legal to run <function>curl_exec</function> on this handle. Removing the <parameter>handle</parameter> handle 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_XXX</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
-->