1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_PRIVATE 3 "December 08, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
26 CURLOPT_PRIVATE \- store a private pointer
28 #include <curl/curl.h>
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);
32 Pass a void * as parameter, pointing to data that should be associated with
33 this curl handle. The pointer can subsequently be retrieved using
34 \fIcurl_easy_getinfo(3)\fP with the CURLINFO_PRIVATE option. libcurl itself
35 never does anything with this data.
42 CURL *curl = curl_easy_init();
43 struct private secrets;
45 struct private *extracted;
46 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
48 /* store a pointer to our private struct */
49 curl_easy_setopt(curl, CURLOPT_PRIVATE, &secrets);
51 curl_easy_perform(curl);
53 /* we can extract the private pointer again too */
54 curl_easy_getinfo(curl, CURLINFO_PRIVATE, &extracted);
60 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
62 .BR CURLOPT_VERBOSE "(3), " CURLOPT_STDERR "(3), "