curl / libcurl / API / curl_share_init

curl_share_init - create a shared object

Name

curl_share_init - create a share object

Synopsis

#include <curl/curl.h>
 
CURLSH *curl_share_init();

Description

This function returns a pointer to a CURLSH handle to be used as input to all the other share-functions, sometimes referred to as a share handle in some places in the documentation. This init call MUST have a corresponding call to curl_share_cleanup when all operations using the share are complete.

This share handle is what you pass to curl using the CURLOPT_SHARE option with curl_easy_setopt, to make that specific curl handle use the data in this share.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURLSHcode sh;
  CURLSH *share = curl_share_init();
  sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
  if(sh)
    printf("Error: %s\n", curl_share_strerror(sh));
}

Availability

Added in curl 7.10

Return value

If this function returns NULL, something went wrong (out of memory, etc.) and therefore the share object was not created.