| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <[email protected]>, 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 |
.\" |
| 23 |
.TH CURLOPT_ERRORBUFFER 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_ERRORBUFFER \- set error buffer for error messages |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, char *buf); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a char * to a buffer that libcurl \fBmay\fP store human readable error |
| 32 |
messages on failures or problems. This may be more helpful than just the |
| 33 |
return code from \fIcurl_easy_perform(3)\fP and related functions. The buffer |
| 34 |
\fBmust be at least CURL_ERROR_SIZE bytes big\fP. |
| 35 |
|
| 36 |
You must keep the associated buffer available until libcurl no longer needs |
| 37 |
it. Failing to do so will cause very odd behavior or even crashes. libcurl |
| 38 |
will need it until you call \fIcurl_easy_cleanup(3)\fP or you set the same |
| 39 |
option again to use a different pointer. |
| 40 |
|
| 41 |
Do not rely on the contents of the buffer unless an error code was returned. |
| 42 |
Since 7.60.0 libcurl will initialize the contents of the error buffer to an |
| 43 |
empty string before performing the transfer. For earlier versions if an error |
| 44 |
code was returned but there was no error detail then the buffer is untouched. |
| 45 |
|
| 46 |
Consider \fICURLOPT_VERBOSE(3)\fP and \fICURLOPT_DEBUGFUNCTION(3)\fP to better |
| 47 |
debug and trace why errors happen. |
| 48 |
.SH DEFAULT |
| 49 |
NULL |
| 50 |
.SH PROTOCOLS |
| 51 |
All |
| 52 |
.SH EXAMPLE |
| 53 |
.nf |
| 54 |
curl = curl_easy_init(); |
| 55 |
if(curl) { |
| 56 |
CURLcode res; |
| 57 |
char errbuf[CURL_ERROR_SIZE]; |
| 58 |
|
| 59 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 60 |
|
| 61 |
/* provide a buffer to store errors in */ |
| 62 |
curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errbuf); |
| 63 |
|
| 64 |
/* set the error buffer as empty before performing a request */ |
| 65 |
errbuf[0] = 0; |
| 66 |
|
| 67 |
/* perform the request */ |
| 68 |
res = curl_easy_perform(curl); |
| 69 |
|
| 70 |
/* if the request did not complete correctly, show the error |
| 71 |
information. if no detailed error information was written to errbuf |
| 72 |
show the more generic information from curl_easy_strerror instead. |
| 73 |
*/ |
| 74 |
if(res != CURLE_OK) { |
| 75 |
size_t len = strlen(errbuf); |
| 76 |
fprintf(stderr, "\\nlibcurl: (%d) ", res); |
| 77 |
if(len) |
| 78 |
fprintf(stderr, "%s%s", errbuf, |
| 79 |
((errbuf[len - 1] != '\\n') ? "\\n" : "")); |
| 80 |
else |
| 81 |
fprintf(stderr, "%s\\n", curl_easy_strerror(res)); |
| 82 |
} |
| 83 |
} |
| 84 |
.fi |
| 85 |
.SH AVAILABILITY |
| 86 |
Always |
| 87 |
.SH RETURN VALUE |
| 88 |
Returns CURLE_OK |
| 89 |
.SH "SEE ALSO" |
| 90 |
.BR CURLOPT_DEBUGFUNCTION "(3), " CURLOPT_VERBOSE "(3), " |
| 91 |
.BR curl_easy_strerror "(3), " curl_multi_strerror "(3), " |
| 92 |
.BR curl_share_strerror "(3) " |