2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-08-19 20:56:58 +00:00
repo/core/curl/files/CURLSHOPT_USERDATA.3
2024-03-15 21:55:38 -05:00

44 lines
1.1 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLSHOPT_USERDATA.md
.TH CURLSHOPT_USERDATA 3 "March 15 2024" libcurl
.SH NAME
CURLSHOPT_USERDATA \- pointer passed to the lock and unlock mutex callbacks
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_USERDATA, void *clientp);
.fi
.SH DESCRIPTION
The \fIclientp\fP parameter is held verbatim by libcurl and is passed on as
the \fIclientp\fP argument to the callbacks set with
\fICURLSHOPT_LOCKFUNC(3)\fP and \fICURLSHOPT_UNLOCKFUNC(3)\fP.
.SH PROTOCOLS
All
.SH EXAMPLE
.nf
struct secrets {
void *custom;
};
int main(void)
{
CURLSHcode sh;
struct secrets private_stuff;
CURLSH *share = curl_share_init();
sh = curl_share_setopt(share, CURLSHOPT_USERDATA, &private_stuff);
if(sh)
printf("Error: %s\\n", curl_share_strerror(sh));
}
.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. See \fIlibcurl\-errors(3)\fP for the full list with
descriptions.
.SH SEE ALSO
.BR CURLSHOPT_LOCKFUNC (3),
.BR curl_share_cleanup (3),
.BR curl_share_init (3),
.BR curl_share_setopt (3)