| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 |
- .\" generated by cd2nroff 0.1 from CURLINFO_PRIVATE.md
- .TH CURLINFO_PRIVATE 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_PRIVATE \- get the private pointer
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a char pointer to receive the pointer to the private data
- associated with the curl handle (set with the \fICURLOPT_PRIVATE(3)\fP).
- Please note that for internal reasons, the value is returned as a char
- pointer, although effectively being a \(aqvoid *\(aq.
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- void *pointer = (void *)0x2345454;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
- /* set the private pointer */
- curl_easy_setopt(curl, CURLOPT_PRIVATE, pointer);
- res = curl_easy_perform(curl);
- /* extract the private pointer again */
- res = curl_easy_getinfo(curl, CURLINFO_PRIVATE, &pointer);
- if(res)
- printf("error: %s\\n", curl_easy_strerror(res));
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 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_PRIVATE (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|
