aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
diff options
context:
space:
mode:
authorPatrick Monnerat <patrick@monnerat.net>2018-01-14 16:08:43 +0100
committerPatrick Monnerat <patrick@monnerat.net>2018-01-14 16:08:43 +0100
commit2c821bba853a739ce4c311a4e8b4a33e75128dd2 (patch)
tree234e77c9fa4279a60c416c663b257edb049fd17e /docs/libcurl
parenta06311be271f9e0db30ee57096f998898f27c817 (diff)
docs: comment about CURLE_READ_ERROR returned by curl_mime_filedata
Diffstat (limited to 'docs/libcurl')
-rw-r--r--docs/libcurl/curl_mime_filedata.37
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/libcurl/curl_mime_filedata.3 b/docs/libcurl/curl_mime_filedata.3
index ca235ad75..c7b76371a 100644
--- a/docs/libcurl/curl_mime_filedata.3
+++ b/docs/libcurl/curl_mime_filedata.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2017, 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
@@ -56,7 +56,10 @@ is retained.
.SH AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
.SH RETURN VALUE
-CURLE_OK or a CURL error code upon failure.
+CURLE_OK or a CURL error code upon failure. CURLE_READ_ERROR is only an
+indication that the file is not yet readable: it can be safely ignored at
+this time, but the file must be made readable before the pertaining
+easy handle is performed.
.SH EXAMPLE
.nf
curl_mime *mime;