aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_multi_cleanup.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2018-08-09 16:37:39 +0200
committerDaniel Stenberg <daniel@haxx.se>2018-08-10 00:24:12 +0200
commit6fac5a3e65217f1686927ecc8eda567888b29d4f (patch)
treef61fa4402d46d3368e81fd515a0e93ecc2713ccc /docs/libcurl/curl_multi_cleanup.3
parentc817a3b64c15c5ee50c8defab7ef7248a7bfc0ce (diff)
docs: mention NULL is fine input to several functions
Fixes #2837 Closes #2858 Reported-by: Markus Elfring
Diffstat (limited to 'docs/libcurl/curl_multi_cleanup.3')
-rw-r--r--docs/libcurl/curl_multi_cleanup.35
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/libcurl/curl_multi_cleanup.3 b/docs/libcurl/curl_multi_cleanup.3
index 07d921605..a945fd698 100644
--- a/docs/libcurl/curl_multi_cleanup.3
+++ b/docs/libcurl/curl_multi_cleanup.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2018, 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
@@ -40,6 +40,9 @@ handle is no longer connected to the multi handle
3 - \fIcurl_multi_cleanup(3)\fP should be called when all easy handles are
removed
+
+Passing in a NULL pointer in \fImulti_handle\fP will make this function return
+CURLM_BAD_HANDLE immediately with no other action.
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code. On success,
CURLM_OK is returned.