CURLOPT_FAILONERROR.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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_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. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FAILONERROR, long fail);
  29. .SH DESCRIPTION
  30. A long parameter set to 1 tells the library to fail the request if the HTTP
  31. code returned is equal to or larger than 400. The default action would be to
  32. return the page normally, ignoring that code.
  33. This method is not fail-safe and there are occasions where non-successful
  34. response codes will slip through, especially when authentication is involved
  35. (response codes 401 and 407).
  36. You might get some amounts of headers transferred before this situation is
  37. detected, like when a "100-continue" is received as a response to a POST/PUT
  38. and a 401 or 407 is received immediately afterwards.
  39. .SH DEFAULT
  40. 0, do not fail on error
  41. .SH PROTOCOLS
  42. HTTP
  43. .SH EXAMPLE
  44. TODO
  45. .SH AVAILABILITY
  46. Along with HTTP
  47. .SH RETURN VALUE
  48. Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
  49. .SH "SEE ALSO"
  50. .BR CURLOPT_HTTP200ALIASES "(3), "