blob: 7c6c8f27678911237087798def8b356cdbcbb236 [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughesf344baa2021-12-07 09:12:34 -08008.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Elliott Hughes34dd5f42021-08-10 13:01:18 -070012.\" * are also available at https://curl.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.\" **************************************************************************
Elliott Hughesf344baa2021-12-07 09:12:34 -080022.TH curl_multi_strerror 3 "November 04, 2021" "libcurl 7.80.0" "libcurl Manual"
Elliott Hughes82be86d2017-09-20 17:00:17 -070023
Lucas Eckels9bd90e62012-08-06 15:07:02 -070024.SH NAME
25curl_multi_strerror - return string describing error code
26.SH SYNOPSIS
27.nf
28.B #include <curl/curl.h>
29.BI "const char *curl_multi_strerror(CURLMcode " errornum ");"
30.SH DESCRIPTION
31The curl_multi_strerror() function returns a string describing the CURLMcode
32error code passed in the argument \fIerrornum\fP.
Elliott Hughesf344baa2021-12-07 09:12:34 -080033.SH EXAMPLE
34.nf
35int still_running;
36
37CURLMcode mc = curl_multi_perform(multi_handle, &still_running);
38if(mc)
39 printf("error: %s\\n", curl_multi_strerror(mc));
40.fi
Lucas Eckels9bd90e62012-08-06 15:07:02 -070041.SH AVAILABILITY
42This function was added in libcurl 7.12.0
43.SH RETURN VALUE
Haibo Huangca2a8022020-07-10 20:17:42 -070044A pointer to a null-terminated string.
Lucas Eckels9bd90e62012-08-06 15:07:02 -070045.SH "SEE ALSO"
Elliott Hughesf344baa2021-12-07 09:12:34 -080046.BR libcurl-errors "(3), " curl_easy_strerror "(3), "
47.BR curl_share_strerror "(3), " curl_url_strerror "(3)"