mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
5b060a4108
... instead of using future tense. + numerous cleanups and improvements + stick to "reuse" not "re-use" + fewer contractions Closes #11713
56 lines
2.1 KiB
Groff
56 lines
2.1 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.TH curl_share_cleanup 3 "8 Aug 2003" "libcurl" "libcurl"
|
|
.SH NAME
|
|
curl_share_cleanup - Clean up 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.
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURLSHcode sh;
|
|
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 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), " curl_share_setopt "(3)"
|