docs/libcurl/opts/CURLOPT_ERRORBUFFER.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_ERRORBUFFER man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLOPT_ERRORBUFFER - set error buffer for error messages <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0">&#35;include &lt;curl/curl.h&gt;
  56 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, char *buf); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  57 <p class="level0">Pass a char * to a buffer that the libcurl may store human readable error messages in on failures or problems. This may be more helpful than just the return code from <span Class="emphasis">curl_easy_perform(3)</span> and related functions. The buffer <span Class="bold">must be at least CURL_ERROR_SIZE bytes big</span>.
  58 <p class="level0">You must keep the associated buffer available until libcurl no longer needs it. Failing to do so will cause very odd behavior or even crashes. libcurl will need it until you call <span Class="emphasis">curl_easy_cleanup(3)</span> or you set the same option again to use a different pointer.
  59 <p class="level0">Consider <a Class="emphasis" href="./CURLOPT_VERBOSE.html">CURLOPT_VERBOSE</a> and <a Class="emphasis" href="./CURLOPT_DEBUGFUNCTION.html">CURLOPT_DEBUGFUNCTION</a> to better debug and trace why errors happen.
  60 <p class="level0">If the library does not return an error, the buffer may not have been touched. Do not rely on the contents in those cases. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  61 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  62 <p class="level0">All <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  63 <p class="level0"><pre class="level0">
  64 curl = curl_easy_init();
  65 if(curl) {
  66 &nbsp; CURLcode res;
  67 &nbsp; char errbuf[CURL_ERROR_SIZE];
  68 &nbsp;
  69 &nbsp; curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  70 &nbsp;
  71 &nbsp; /* provide a buffer to store errors in */
  72 &nbsp; curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errbuf);
  73 &nbsp;
  74 &nbsp; /* set the error buffer as empty before performing a request */
  75 &nbsp; errbuf[0] = 0;
  76 &nbsp;
  77 &nbsp; /* perform the request */
  78 &nbsp; res = curl_easy_perform(curl);
  79 &nbsp;
  80 &nbsp; /* if the request did not complete correctly, show the error
  81 &nbsp; information. if no detailed error information was written to errbuf
  82 &nbsp; show the more generic information from curl_easy_strerror instead.
  83 &nbsp; */
  84 &nbsp; if(res != CURLE_OK) {
  85 &nbsp;   size_t len = strlen(errbuf);
  86 &nbsp;   fprintf(stderr, "\nlibcurl: (%d) ", res);
  87 &nbsp;   if(len)
  88 &nbsp;     fprintf(stderr, "%s%s", errbuf,
  89 &nbsp;             ((errbuf[len - 1] != '\n') ? "\n" : ""));
  90 &nbsp;   else
  91 &nbsp;     fprintf(stderr, "%s\n", curl_easy_strerror(res));
  92 &nbsp; }
  93 }
  94 </pre>
  95
  96 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  97 <p class="level0">Always <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  98 <p class="level0">Returns CURLE_OK <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  99 <p class="level0"><a Class="manpage" href="./CURLOPT_DEBUGFUNCTION.html">CURLOPT_DEBUGFUNCTION</a>, <a Class="manpage" href="./CURLOPT_VERBOSE.html">CURLOPT_VERBOSE</a>, <span Class="manpage">curl_easy_strerror (3)</span>, <span Class="manpage">curl_multi_strerror (3)</span>, <span Class="manpage">curl_share_strerror (3)</span><p class="roffit">
 100  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
 101 </body></html>