curl/docs/libcurl/curl_url_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

56 lines
932 B
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_url_strerror
Section: 3
Source: libcurl
See-also:
- curl_easy_strerror (3)
- curl_multi_strerror (3)
- curl_share_strerror (3)
- curl_url_get (3)
- curl_url_set (3)
- libcurl-errors (3)
Protocol:
- All
---
# NAME
curl_url_strerror - return string describing error code
# SYNOPSIS
~~~c
#include <curl/curl.h>
const char *curl_url_strerror(CURLUcode errornum);
~~~
# DESCRIPTION
This function returns a string describing the CURLUcode error code passed in
the argument *errornum*.
# EXAMPLE
~~~c
int main(void)
{
CURLUcode rc;
CURLU *url = curl_url();
rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
if(rc)
printf("URL error: %s\n", curl_url_strerror(rc));
curl_url_cleanup(url);
}
~~~
# AVAILABILITY
Added in 7.80.0
# RETURN VALUE
A pointer to a null-terminated string.