manpagez: man pages & more
man CURLSHOPT_USERDATA(3)
Home | html | info | man
CURLSHOPT_USERDATA(3)      Library Functions Manual      CURLSHOPT_USERDATA(3)


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(3)
       and CURLSHOPT_UNLOCKFUNC(3).


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(3) for the full list with
       descriptions.


SEE ALSO

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

libcurl                           2024-08-05             CURLSHOPT_USERDATA(3)

curl 8.9.1 - Generated Wed Aug 7 15:28:33 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.