diff options
author | Daniel Stenberg <daniel@haxx.se> | 2009-04-06 21:44:53 +0000 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2009-04-06 21:44:53 +0000 |
commit | 875c55d86bcfb35f01106865b60dcd1594bfc340 (patch) | |
tree | d061e4b71dfb166886dcfda754a0efe8a4546a9b /docs | |
parent | b85154f13fa5bf25d7da2fa4eaa05fb683ba3aa3 (diff) |
- I clarified in the docs that CURLOPT_SEEKFUNCTION should return 0 on success
and 1 on fatal errors. Previously it only mentioned non-zero on fatal
errors. This is a slight change in meaning, but it follows what we've done
elsewhere before and it opens up for LOTS of more useful return codes
whenever we can think of them...
Diffstat (limited to 'docs')
-rw-r--r-- | docs/libcurl/curl_easy_setopt.3 | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index 9599b65e6..9de7ab651 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -208,9 +208,10 @@ currently only one value is supported: \fICURLSOCKTYPE_IPCXN\fP for the primary connection (meaning the control connection in the FTP case). Future versions of libcurl may support more purposes. It passes the newly created socket descriptor so additional setsockopt() calls can be done at the user's -discretion. A non-zero return code from the callback function will signal an -unrecoverable error to the library and it will close the socket and return -\fICURLE_COULDNT_CONNECT\fP. (Option added in 7.15.6.) +discretion. Return 0 (zero) from the callback on success. Return 1 from the +callback function to signal an unrecoverable error to the library and it will +close the socket and return \fICURLE_COULDNT_CONNECT\fP. (Option added in +7.15.6.) .IP CURLOPT_SOCKOPTDATA Pass a pointer that will be untouched by libcurl and passed as the first argument in the sockopt callback set with \fICURLOPT_SOCKOPTFUNCTION\fP. |