comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_PRIVATE.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
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.
13 .\" *
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.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_PRIVATE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PRIVATE \- store a private pointer
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);
30 .SH DESCRIPTION
31 Pass a void * as parameter, pointing to data that should be associated with
32 this curl handle. The pointer can subsequently be retrieved using
33 \fIcurl_easy_getinfo(3)\fP with the CURLINFO_PRIVATE option. libcurl itself
34 never does anything with this data.
35 .SH DEFAULT
36 NULL
37 .SH PROTOCOLS
38 All
39 .SH EXAMPLE
40 .nf
41 CURL *curl = curl_easy_init();
42 struct private secrets;
43 if(curl) {
44 struct private *extracted;
45 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
46
47 /* store a pointer to our private struct */
48 curl_easy_setopt(curl, CURLOPT_PRIVATE, &secrets);
49
50 curl_easy_perform(curl);
51
52 /* we can extract the private pointer again too */
53 curl_easy_getinfo(curl, CURLINFO_PRIVATE, &extracted);
54 }
55 .fi
56 .SH AVAILABILITY
57 Added in 7.10.3
58 .SH RETURN VALUE
59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60 .SH "SEE ALSO"
61 .BR CURLOPT_VERBOSE "(3), " CURLOPT_STDERR "(3), "