mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
54 lines
1.6 KiB
Groff
54 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_FAILONERROR.md
|
|
.TH CURLOPT_FAILONERROR 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_FAILONERROR \- request failure on HTTP response >= 400
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FAILONERROR, long fail);
|
|
.fi
|
|
.SH 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 \fICURLE_HTTP_RETURNED_ERROR\fP is returned.
|
|
.SH DEFAULT
|
|
0, do not fail on error
|
|
.SH PROTOCOLS
|
|
HTTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
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 */
|
|
}
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Along with HTTP.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLINFO_RESPONSE_CODE (3),
|
|
.BR CURLOPT_HTTP200ALIASES (3),
|
|
.BR CURLOPT_KEEP_SENDING_ON_ERROR (3)
|