| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, 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. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_PRIVATE 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_PRIVATE \- store a private pointer |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer); |
| .SH DESCRIPTION |
| Pass a void * as parameter, pointing to data that should be associated with |
| this curl handle. The pointer can subsequently be retrieved using |
| \fIcurl_easy_getinfo(3)\fP with the CURLINFO_PRIVATE option. libcurl itself |
| never does anything with this data. |
| .SH DEFAULT |
| NULL |
| .SH PROTOCOLS |
| All |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| struct private secrets; |
| if(curl) { |
| struct private *extracted; |
| curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| |
| /* store a pointer to our private struct */ |
| curl_easy_setopt(curl, CURLOPT_PRIVATE, &secrets); |
| |
| curl_easy_perform(curl); |
| |
| /* we can extract the private pointer again too */ |
| curl_easy_getinfo(curl, CURLINFO_PRIVATE, &extracted); |
| } |
| .fi |
| .SH AVAILABILITY |
| Added in 7.10.3 |
| .SH RETURN VALUE |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| .SH "SEE ALSO" |
| .BR CURLOPT_VERBOSE "(3), " CURLOPT_STDERR "(3), " |
