]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
curl_multi_socket_action.3: add a "RETURN VALUE" section
authorJay Satiro <raysatiro@yahoo.com>
Sun, 24 Oct 2021 21:52:54 +0000 (17:52 -0400)
committerJay Satiro <raysatiro@yahoo.com>
Mon, 25 Oct 2021 07:25:40 +0000 (03:25 -0400)
.. 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

docs/libcurl/curl_multi_socket_action.3

index 9205cd8784b148f226772f9f1654853d0192249a..1fe58268f59aa2ee96b7d1ceed8c46508d7232a7 100644 (file)
@@ -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"