curl / libcurl / API / curl_easy_setopt / CURLOPT_PRIVATE

CURLOPT_PRIVATE explained

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 with the CURLINFO_PRIVATE option. libcurl itself never does anything with this data.

Default

NULL

Protocols

This functionality affects all supported protocols

Example

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

Availability

Added in curl 7.10.3

Return value

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