Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PRIVATE (3)

Name

CURLOPT_PRIVATE - store a private pointer

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);

Description

CURLOPT_PRIVATE(3)         curl_easy_setopt options         CURLOPT_PRIVATE(3)



NAME
       CURLOPT_PRIVATE - store a private pointer

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);

DESCRIPTION
       Pass  a void * as parameter, pointing to data that should be associated
       with this curl handle.  The pointer can subsequently be retrieved using
       curl_easy_getinfo(3)  with  the CURLINFO_PRIVATE option. libcurl itself
       never does anything with this data.

DEFAULT
       NULL

PROTOCOLS
       All

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

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
       CURLOPT_VERBOSE(3), CURLOPT_STDERR(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021            CURLOPT_PRIVATE(3)