curl/docs/libcurl/curl_share_strerror.md
Daniel Stenberg e3fe020089
docs/libcurl: generate PROTOCOLS from meta-data
Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175
2024-03-23 18:13:03 +01:00

937 B

c SPDX-License-Identifier Title Section Source See-also Protocol
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_share_strerror 3 libcurl
curl_easy_strerror (3)
curl_multi_strerror (3)
curl_url_strerror (3)
libcurl-errors (3)
All

NAME

curl_share_strerror - return string describing error code

SYNOPSIS

#include <curl/curl.h>

const char *curl_share_strerror(CURLSHcode errornum);

DESCRIPTION

The curl_share_strerror(3) function returns a string describing the CURLSHcode error code passed in the argument errornum.

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

This function was added in libcurl 7.12.0

RETURN VALUE

A pointer to a null-terminated string.