curl/docs/libcurl/curl_easy_strerror.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.1 KiB

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

NAME

curl_easy_strerror - return string describing error code

SYNOPSIS

#include <curl/curl.h>

const char *curl_easy_strerror(CURLcode errornum);

DESCRIPTION

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

Typically applications also appreciate CURLOPT_ERRORBUFFER(3) for more specific error descriptions generated at runtime.

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    /* set options */
    /* Perform the entire transfer */
    res = curl_easy_perform(curl);
    /* Check for errors */
    if(res != CURLE_OK)
      fprintf(stderr, "curl_easy_perform() failed: %s\n",
              curl_easy_strerror(res));
  }
}

RETURN VALUE

A pointer to a null-terminated string.