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 http://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 the libcurl may store human readable error
  32 messages in 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 Consider \fICURLOPT_VERBOSE(3)\fP and \fICURLOPT_DEBUGFUNCTION(3)\fP to better
  42 debug and trace why errors happen.
  43
  44 If the library does not return an error, the buffer may not have been
  45 touched. Do not rely on the contents in those cases.
  46 .SH DEFAULT
  47 NULL
  48 .SH PROTOCOLS
  49 All
  50 .SH EXAMPLE
  51 .nf
  52 curl = curl_easy_init();
  53 if(curl) {
  54   char error[CURL_ERROR_SIZE]
  55
  56   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  57
  58   /* provide a buffer to store errors in */
  59   curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, error);
  60
  61   /* Perform the request */
  62   curl_easy_perform(curl);
  63 }
  64 .fi
  65 .SH AVAILABILITY
  66 Always
  67 .SH RETURN VALUE
  68 Returns CURLE_OK
  69 .SH "SEE ALSO"
  70 .BR CURLOPT_DEBUGFUNCTION "(3), " CURLOPT_VERBOSE "(3), "
  71 .BR curl_easy_strerror "(3), " curl_multi_strerror "(3), "
  72 .BR curl_share_strerror "(3) "