Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / curl_easy_strerror.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .TH curl_easy_strerror 3 "February 03, 2016" "libcurl 7.59.0" "libcurl Manual"
23
24 .SH NAME
25 curl_easy_strerror - return string describing error code
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 const char *curl_easy_strerror(CURLcode errornum);
30 .SH DESCRIPTION
31 The \fIcurl_easy_strerror(3)\fP function returns a string describing the
32 CURLcode error code passed in the argument \fIerrornum\fP.
33
34 Typically applications also appreciate \fICURLOPT_ERRORBUFFER(3)\fP for more
35 specific error descriptions generated at run-time.
36 .SH AVAILABILITY
37 This function was added in libcurl 7.12.0
38 .SH RETURN VALUE
39 A pointer to a zero terminated string.
40 .SH "SEE ALSO"
41 .BR libcurl-errors "(3), " curl_multi_strerror "(3), " curl_share_strerror "(3)"