curl / libcurl / API / curl_share_setopt / CURLSHOPT_USERDATA

CURLSHOPT_USERDATA explained

Name

CURLSHOPT_USERDATA - pointer passed to the (un)lock mutex callbacks

Synopsis

#include <curl/curl.h>
 
CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_USERDATA, void *ptr);

Description

The ptr parameter is held verbatim by libcurl and is passed on as the userptr argument to the callbacks set with CURLSHOPT_LOCKFUNC and CURLSHOPT_UNLOCKFUNC.

Protocols

All

Example

  CURLSHcode sh;
  struct secrets private_stuff;
  share = curl_share_init();
  sh = curl_share_setopt(share, CURLSHOPT_USERDATA, &private_stuff);
  if(sh)
    printf("Error: %s\n", curl_share_strerror(sh));

Availability

Added in 7.10

Return value

CURLSHE_OK (zero) means that the option was set properly, non-zero means an error occurred. See libcurl-errors for the full list with descriptions.

See also

CURLSHOPT_LOCKFUNC(3), curl_share_setopt(3), curl_share_cleanup(3), curl_share_init(3)

This HTML page was made with roffit.