docs/libcurl/opts/CURLOPT_FAILONERROR.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_FAILONERROR 3 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_FAILONERROR \- request failure on HTTP response >= 400
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FAILONERROR, long fail);
  31 .SH DESCRIPTION
  32 A long parameter set to 1 tells the library to fail the request if the HTTP
  33 code returned is equal to or larger than 400. The default action would be to
  34 return the page normally, ignoring that code.
  35
  36 This method is not fail-safe and there are occasions where non-successful
  37 response codes will slip through, especially when authentication is involved
  38 (response codes 401 and 407).
  39
  40 You might get some amounts of headers transferred before this situation is
  41 detected, like when a "100-continue" is received as a response to a POST/PUT
  42 and a 401 or 407 is received immediately afterwards.
  43
  44 When this option is used and an error is detected, it will cause the
  45 connection to get closed and \fICURLE_HTTP_RETURNED_ERROR\fP is returned.
  46 .SH DEFAULT
  47 0, do not fail on error
  48 .SH PROTOCOLS
  49 HTTP
  50 .SH EXAMPLE
  51 .nf
  52 CURL *curl = curl_easy_init();
  53 if(curl) {
  54   CURLcode ret;
  55   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  56   curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1L);
  57   ret = curl_easy_perform(curl);
  58   if(ret == CURLE_HTTP_RETURNED_ERROR) {
  59     /* a HTTP response error problem */
  60   }
  61 }
  62 .fi
  63 .SH AVAILABILITY
  64 Along with HTTP.
  65 .SH RETURN VALUE
  66 Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
  67 .SH "SEE ALSO"
  68 .BR CURLOPT_HTTP200ALIASES "(3), " CURLOPT_KEEP_SENDING_ON_ERROR "(3), "