curl/docs/libcurl/curl_share_setopt.md
Daniel Stenberg d94733b447
docs: make curldown do angle brackets like markdown
Make sure we use \< and \> in markdown all over so that it renders
correctly, on GitHub and elsewhere. cd2nroff now outputs a warning if it
finds an unescaled angle bracket.

Ref: #12854
Closes #12869
2024-02-06 08:17:40 +01:00

1.2 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel.se>, et al. curl curl_share_setopt 3 libcurl
curl_share_cleanup (3)
curl_share_init (3)

NAME

curl_share_setopt - Set options for a shared object

SYNOPSIS

#include <curl/curl.h>

CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter);

DESCRIPTION

Set the option to parameter for the given share.

OPTIONS

CURLSHOPT_LOCKFUNC

See CURLSHOPT_LOCKFUNC(3).

CURLSHOPT_UNLOCKFUNC

See CURLSHOPT_UNLOCKFUNC(3).

CURLSHOPT_SHARE

See CURLSHOPT_SHARE(3).

CURLSHOPT_UNSHARE

See CURLSHOPT_UNSHARE(3).

CURLSHOPT_USERDATA

See CURLSHOPT_USERDATA(3).

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 7.10

RETURN VALUE

CURLSHE_OK (zero) means that the option was set properly, non-zero means an error occurred as <curl/curl.h> defines. See the libcurl-errors(3) man page for the full list with descriptions.