curl / libcurl / API / curl_share_setopt / CURLSHOPT_USERDATA

CURLSHOPT_USERDATA explained

Name

CURLSHOPT_USERDATA - pointer passed to the lock and unlock mutex callbacks

Synopsis

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

Description

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

Protocols

This functionality affects all supported protocols

Example

struct secrets {
  void *custom;
};
 
int main(void)
{
  CURLSHcode sh;
  struct secrets private_stuff;
  CURLSH *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 curl 7.10.3

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.