55 lines
1.4 KiB
Groff
55 lines
1.4 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_PRIVATE.md
|
||
|
|
.TH CURLOPT_PRIVATE 3 "2025-07-07" libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_PRIVATE \- store a private pointer
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);
|
||
|
|
.fi
|
||
|
|
.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 \fICURLINFO_PRIVATE(3)\fP option. libcurl itself
|
||
|
|
never does anything with this data.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
This functionality affects all supported protocols
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
struct private {
|
||
|
|
void *custom;
|
||
|
|
};
|
||
|
|
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
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 curl 7.10.3
|
||
|
|
.SH RETURN VALUE
|
||
|
|
\fIcurl_easy_setopt(3)\fP returns a CURLcode indicating success or error.
|
||
|
|
|
||
|
|
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
|
||
|
|
\fIlibcurl\-errors(3)\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR CURLINFO_PRIVATE (3),
|
||
|
|
.BR CURLOPT_STDERR (3),
|
||
|
|
.BR CURLOPT_VERBOSE (3)
|