docs/libcurl/opts/CURLOPT_FAILONERROR.3

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