summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJay Satiro <raysatiro@yahoo.com>2021-10-24 17:52:54 -0400
committerJay Satiro <raysatiro@yahoo.com>2021-10-25 03:25:40 -0400
commitaa429d49b33c4264d8d5c1c2568862742784e538 (patch)
tree16680b85a4ac3e03815635678f38486c03ffaa41
parent6d071c8b5a9e7d99e8789369c940efc2f899e01c (diff)
downloadcurl-aa429d49b33c4264d8d5c1c2568862742784e538.tar.gz
curl_multi_socket_action.3: add a "RETURN VALUE" section
.. because it may not be immediately clear to the user what curl_multi_socket_action returns. Ref: https://curl.se/mail/lib-2021-10/0035.html Closes https://github.com/curl/curl/pull/7901
-rw-r--r--docs/libcurl/curl_multi_socket_action.33
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/libcurl/curl_multi_socket_action.3 b/docs/libcurl/curl_multi_socket_action.3
index 9205cd878..1fe58268f 100644
--- a/docs/libcurl/curl_multi_socket_action.3
+++ b/docs/libcurl/curl_multi_socket_action.3
@@ -88,6 +88,9 @@ callback has been told.
8, When activity is detected, call curl_multi_socket_action() for the
socket(s) that got action. If no activity is detected and the timeout expires,
call \fIcurl_multi_socket_action(3)\fP with \fICURL_SOCKET_TIMEOUT\fP.
+.SH RETURN VALUE
+CURLMcode type, general libcurl multi interface error code. See
+\fIlibcurl-errors(3)\fP
.SH AVAILABILITY
This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
.SH "SEE ALSO"