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