curl/docs/libcurl/curl_share_setopt.md
Daniel Stenberg 5a488251f7
curldown: fixups
- make DEFAULT sections less repetitive

- make historic mentions use HISTORY

- generate the protocols section on `# %PROTOCOLS%` instead of guessing
  where to put it

- generate the availability section on `# %AVAILABILITY%` instead of
  guessing where to put it

- make the protocols section more verbose

Closes #14227
2024-07-19 17:03:25 +02:00

1.2 KiB

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

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).

%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%

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.