Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_PRIVATE (3)

Name

CURLINFO_PRIVATE - get the private pointer

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **pri-
vate);

Description

CURLINFO_PRIVATE(3)        curl_easy_getinfo options       CURLINFO_PRIVATE(3)



NAME
       CURLINFO_PRIVATE - get the private pointer

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **pri-
       vate);

DESCRIPTION
       Pass a pointer to a char pointer to receive the pointer to the  private
       data associated with the curl handle (set with the CURLOPT_PRIVATE(3)).
       Please note that for internal reasons, the value is returned as a  char
       pointer, although effectively being a 'void *'.

PROTOCOLS
       All

EXAMPLE
       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);
       }

AVAILABILITY
       Added in 7.10.3

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3), CURLOPT_PRIVATE(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.44.0                    1 Sep 2015               CURLINFO_PRIVATE(3)