.\" generated by cd2nroff 0.1 from curl_share_cleanup.md
.TH curl_share_cleanup 3 "2024-11-18" libcurl
.SH NAME
curl_share_cleanup \- close a shared object
.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.

Any use of the \fBshare_handle\fP after this function has been called and have
returned, is illegal.
.SH PROTOCOLS
This functionality affects all supported protocols
.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
Added in curl 7.10
.SH RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non\-zero means an
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.
.SH SEE ALSO
.BR curl_share_init (3),
.BR curl_share_setopt (3)