generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

curl_easy_recv.3: document return codes

Browse Source 
Reported by: Craig Davison
Bug: http://curl.haxx.se/mail/lib-2013-01/0234.html
This commit is contained in:
Daniel Stenberg 2013-01-19 22:58:02 +01:00
parent ece8681a60
commit d90b9aee64
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/libcurl/curl_easy_recv.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -59,8 +59,13 @@ On success, returns \fBCURLE_OK\fP, stores the received data into
On failure, returns the appropriate error code. On failure, returns the appropriate error code.
If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use your
your operating system facilities to wait until the data is ready, and retry. operating system facilities to wait until the data is ready, and retry.
Reading exactly 0 bytes would indicate a closed connection.
If there's no socket available to use from the previous transfer, this function
returns CURLE_UNSUPPORTED_PROTOCOL.
.SH EXAMPLE .SH EXAMPLE
See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example. See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example.
.SH "SEE ALSO" .SH "SEE ALSO"