eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
60 lines
1.1 KiB
Markdown
60 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_easy_strerror
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_multi_strerror (3)
|
|
- curl_share_strerror (3)
|
|
- curl_url_strerror (3)
|
|
- libcurl-errors (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_easy_strerror - return string describing error code
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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
|
|
|
|
~~~c
|
|
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));
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
This function was added in libcurl 7.12.0
|
|
|
|
# RETURN VALUE
|
|
|
|
A pointer to a null-terminated string.
|