Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLSHOPT_USERDATA (3)

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

CURLSHOPT_USERDATA(3)           libcurl Manual           CURLSHOPT_USERDATA(3)



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

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

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



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                  April 15, 2022           CURLSHOPT_USERDATA(3)