2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_share_cleanup.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH curl_share_cleanup 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
2024-07-29 18:00:04 -06:00
|
|
|
curl_share_cleanup \- close a shared object
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLSHcode curl_share_cleanup(CURLSH *share_handle);
|
|
|
|
|
.fi
|
|
|
|
|
.SH 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 \fIshare_handle\fP makes this function return
|
|
|
|
|
immediately with no action.
|
2024-07-29 18:00:04 -06:00
|
|
|
|
|
|
|
|
Any use of the \fBshare_handle\fP after this function has been called and have
|
|
|
|
|
returned, is illegal.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all supported protocols
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
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);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.10
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
CURLSHE_OK (zero) means that the option was set properly, non\-zero means an
|
2024-03-30 12:28:04 -06:00
|
|
|
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl\-errors(3)\fP man
|
|
|
|
|
page for the full list with descriptions. If an error occurs, then the share
|
|
|
|
|
object is not deleted.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR curl_share_init (3),
|
|
|
|
|
.BR curl_share_setopt (3)
|
