| 12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- .\" generated by cd2nroff 0.1 from CURLSHOPT_USERDATA.md
- .TH CURLSHOPT_USERDATA 3 "2025-01-17" 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
- This functionality affects all supported protocols
- .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 curl 7.10.3
- .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)
|
