Return to curl_multi_remove_handle.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_multi_remove_handle.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .TH curl_multi_remove_handle 3 "February 19, 2019" "libcurl 7.70.0" "libcurl Manual"
                     23: 
                     24: .SH NAME
                     25: curl_multi_remove_handle - remove an easy handle from a multi session
                     26: .SH SYNOPSIS
                     27: #include <curl/curl.h>
                     28: 
                     29: CURLMcode curl_multi_remove_handle(CURLM *multi_handle, CURL *easy_handle);
                     30: .ad
                     31: .SH DESCRIPTION
                     32: Removes a given \fIeasy_handle\fP from the \fImulti_handle\fP. This will make
                     33: the specified easy handle be removed from this multi handle's control.
                     34: 
                     35: When the easy handle has been removed from a multi stack, it is again
                     36: perfectly legal to invoke \fIcurl_easy_perform(3)\fP on this easy handle.
                     37: 
                     38: Removing an easy handle while being used is perfectly legal and will
                     39: effectively halt the transfer in progress involving that easy handle. All
                     40: other easy handles and transfers will remain unaffected.
                     41: 
                     42: It is fine to remove a handle at any time during a transfer, just not from
                     43: within any libcurl callback function.
                     44: .SH RETURN VALUE
                     45: CURLMcode type, general libcurl multi interface error code.
                     46: .SH "SEE ALSO"
                     47: .BR curl_multi_cleanup "(3)," curl_multi_init "(3), "
                     48: .BR curl_multi_add_handle "(3) "