2024-01-17 18:32:44 +08:00
|
|
|
---
|
2024-02-28 18:28:10 +08:00
|
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
2024-01-17 18:32:44 +08:00
|
|
|
SPDX-License-Identifier: curl
|
|
|
|
Title: curl_share_cleanup
|
|
|
|
Section: 3
|
|
|
|
Source: libcurl
|
|
|
|
See-also:
|
|
|
|
- curl_share_init (3)
|
|
|
|
- curl_share_setopt (3)
|
2024-03-21 18:50:20 +08:00
|
|
|
Protocol:
|
2024-03-23 06:48:54 +08:00
|
|
|
- All
|
2024-07-18 06:51:50 +08:00
|
|
|
Added-in: 7.10
|
2024-01-17 18:32:44 +08:00
|
|
|
---
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
2024-06-30 06:08:06 +08:00
|
|
|
curl_share_cleanup - close a shared object
|
2024-01-17 18:32:44 +08:00
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
|
|
~~~c
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
CURLSHcode curl_share_cleanup(CURLSH *share_handle);
|
|
|
|
~~~
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
This function deletes a shared object. The share handle cannot be used anymore
|
|
|
|
when this function has been called.
|
|
|
|
|
|
|
|
Passing in a NULL pointer in *share_handle* makes this function return
|
|
|
|
immediately with no action.
|
|
|
|
|
2024-07-23 01:04:12 +08:00
|
|
|
Any use of the **share_handle** after this function has been called and have
|
|
|
|
returned, is illegal.
|
|
|
|
|
2024-07-19 07:06:06 +08:00
|
|
|
# %PROTOCOLS%
|
|
|
|
|
2024-01-17 18:32:44 +08:00
|
|
|
# EXAMPLE
|
|
|
|
|
|
|
|
~~~c
|
|
|
|
int main(void)
|
|
|
|
{
|
|
|
|
CURLSHcode sh;
|
|
|
|
CURLSH *share = curl_share_init();
|
|
|
|
sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
|
|
|
|
/* use the share, then ... */
|
|
|
|
curl_share_cleanup(share);
|
|
|
|
}
|
|
|
|
~~~
|
|
|
|
|
2024-07-19 07:06:06 +08:00
|
|
|
# %AVAILABILITY%
|
|
|
|
|
2024-01-17 18:32:44 +08:00
|
|
|
# RETURN VALUE
|
|
|
|
|
|
|
|
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
|
2024-02-06 06:23:56 +08:00
|
|
|
error occurred as *\<curl/curl.h\>* defines. See the libcurl-errors(3) man
|
|
|
|
page for the full list with descriptions. If an error occurs, then the share
|
|
|
|
object is not deleted.
|