iw7-mod/deps/curl/docs/libcurl/curl_share_cleanup.md

55 lines
1.1 KiB
Markdown
Raw Normal View History

2024-08-13 05:15:34 -04:00
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_share_cleanup
Section: 3
Source: libcurl
See-also:
- curl_share_init (3)
- curl_share_setopt (3)
---
# NAME
curl_share_cleanup - Clean up a shared object
# 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.
# 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);
}
~~~
# AVAILABILITY
Added in 7.10
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
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.