curl / libcurl / API / curl_easy_setopt / CURLOPT_FAILONERROR

CURLOPT_FAILONERROR explained

Name

CURLOPT_FAILONERROR - request failure on HTTP response >= 400

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FAILONERROR, long fail);

Description

A long parameter set to 1 tells the library to fail the request if the HTTP code returned is equal to or larger than 400. The default action would be to return the page normally, ignoring that code.

This method is not fail-safe and there are occasions where non-successful response codes slip through, especially when authentication is involved (response codes 401 and 407).

You might get some amounts of headers transferred before this situation is detected, like when a "100-continue" is received as a response to a POST/PUT and a 401 or 407 is received immediately afterwards.

When this option is used and an error is detected, it causes the connection to get closed and CURLE_HTTP_RETURNED_ERROR is returned.

Default

0, do not fail on error

Protocols

This functionality affects http only

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode ret;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1L);
    ret = curl_easy_perform(curl);
    if(ret == CURLE_HTTP_RETURNED_ERROR) {
      /* an HTTP response error problem */
    }
  }
}

Availability

Added in curl 7.1

Return value

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.