aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_FAILONERROR.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2017-05-30 23:35:30 +0200
committerDaniel Stenberg <daniel@haxx.se>2017-05-30 23:35:30 +0200
commitbb1a8c174bc2407451b71842d970f5f7b395a2f1 (patch)
treecdbd0fc8b0548f1775e8e705200811095d536d95 /docs/libcurl/opts/CURLOPT_FAILONERROR.3
parent2d5fa35e85c6e0ba84e6922e321bbe3a4511cdf9 (diff)
opts: more examples added to man pages
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_FAILONERROR.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_FAILONERROR.319
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/libcurl/opts/CURLOPT_FAILONERROR.3 b/docs/libcurl/opts/CURLOPT_FAILONERROR.3
index 93d8ba6ed..451b07cad 100644
--- a/docs/libcurl/opts/CURLOPT_FAILONERROR.3
+++ b/docs/libcurl/opts/CURLOPT_FAILONERROR.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -41,15 +41,26 @@ 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 will cause the
-connection to get closed.
+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
-TODO
+.nf
+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) {
+ /* a HTTP response error problem */
+ }
+}
+.fi
.SH AVAILABILITY
-Along with HTTP
+Along with HTTP.
.SH RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO"