docs/libcurl/opts: clarify the return values

Expand a little.

- mention the type name of the return code
- avoid stating which exact return codes that might be returned, as that
  varies over time, builds and conditions
- avoid stating some always return OK
- refer to the manpage documenting all the return codes

Closes #15900
This commit is contained in:
Daniel Stenberg 2025-01-02 15:54:12 +01:00
parent e256d9df6d
commit e694c8284a
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
376 changed files with 1508 additions and 483 deletions

View file

@ -135,4 +135,7 @@ int main(void)
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
curl_easy_setopt(3) returns a CURLcode indicating success or error.
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
libcurl-errors(3).