Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_multi_remove_handle (3)

Name

curl_multi_remove_handle - remove an easy handle from a multi session

Synopsis

#include <curl/curl.h>

CURLMcode curl_multi_remove_handle(CURLM *multi_handle, CURL *easy_handle);

Description

libcurl Manual                                     curl_multi_remove_handle(3)



NAME
       curl_multi_remove_handle - remove an easy handle from a multi session

SYNOPSIS
       #include <curl/curl.h>

       CURLMcode curl_multi_remove_handle(CURLM *multi_handle, CURL *easy_handle);

DESCRIPTION
       Removes  a  given easy_handle from the multi_handle. This will make the
       specified easy handle be removed from this multi handle's control.

       When the easy handle has been removed from a multi stack, it  is  again
       perfectly legal to invoke curl_easy_perform(3) on this easy handle.

       Removing  an  easy  handle while being used is perfectly legal and will
       effectively halt the transfer in progress involving that  easy  handle.
       All other easy handles and transfers will remain unaffected.

       It  is  fine to remove a handle at any time during a transfer, just not
       from within any libcurl callback function.

EXAMPLE
       /* when an easy handle has completed, remove it */
       msg = curl_multi_info_read(multi_handle, &queued);
       if(msg) {
         if(msg->msg == CURLMSG_DONE) {
           /* a transfer ended */
           fprintf(stderr, "Transfer completed\n");
           curl_multi_remove_handle(multi_handle, msg->easy_handle);
         }
       }

AVAILABILITY
       Added in 7.9.6

RETURN VALUE
       CURLMcode type, general libcurl multi interface error code.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_multi_cleanup(3),curl_multi_init(3), curl_multi_add_handle(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021
                                                   curl_multi_remove_handle(3)