| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * 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 CURLSHOPT_USERDATA 3 "8 Aug 2003" libcurl 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 |
| CURLSHcode sh; |
| struct secrets private_stuff; |
| 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_setopt "(3), " curl_share_cleanup "(3), " curl_share_init "(3)" |
