61 lines
2.2 KiB
Groff
61 lines
2.2 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 1998 - 2017, 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.haxx.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 CURLINFO_PRIVATE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
|
||
|
|
.SH NAME
|
||
|
|
CURLINFO_PRIVATE \- get the private pointer
|
||
|
|
.SH SYNOPSIS
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private);
|
||
|
|
.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 'void *'.
|
||
|
|
.SH PROTOCOLS
|
||
|
|
All
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
void *pointer = 0x2345454;
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
|
||
|
|
|
||
|
|
/* set the private pointer */
|
||
|
|
curl_easy_setopt(curl, CURLOPT_PRIVATE, pointer);
|
||
|
|
ret = curl_easy_perform(curl);
|
||
|
|
|
||
|
|
/* extract the private pointer again */
|
||
|
|
ret = curl_easy_getinfo(curl, CURLINFO_PRIVATE, &pointer);
|
||
|
|
|
||
|
|
curl_easy_cleanup(curl);
|
||
|
|
}
|
||
|
|
.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 curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
|
||
|
|
.BR CURLOPT_PRIVATE "(3), "
|