Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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, "http://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.

SEE ALSO
       CURLOPT_VERBOSE(3), CURLOPT_STDERR(3),

libcurl	7.72.0			March 23, 2020		    CURLOPT_PRIVATE(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | PROTOCOLS | EXAMPLE | AVAILABILITY | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_PRIVATE&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help