CURLOPT_PRIVATE3

Usage

#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);

Overview

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(3) option. libcurl itself never does anything with this data.

Default

NULL

Protocols

This functionality affects all supported protocols

Examples

struct private_data {
  void *custom;
};
int main(void)
{
  CURL *curl = curl_easy_init();
  struct private_data secrets;
  if(curl) {
    CURLcode result;
    struct private_data *extracted;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    /* store a pointer to our private_data struct */
    curl_easy_setopt(curl, CURLOPT_PRIVATE, &secrets);
    result = curl_easy_perform(curl);
    /* we can extract the private_data pointer again too */
    curl_easy_getinfo(curl, CURLINFO_PRIVATE, &extracted);
    curl_easy_cleanup(curl);
  }
}

Return value

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).