summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_READDATA.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-06-16 23:01:12 +0200
committerDaniel Stenberg <daniel@haxx.se>2014-06-16 23:01:12 +0200
commit28b698858ca905bb9d1bf6f0b6f1557cbc4a7db5 (patch)
tree0353c9257f27002cbef2dadb8c394fddfb643d78 /docs/libcurl/opts/CURLOPT_READDATA.3
parent7ad9cb12b226bc825893a715a5c0a7f2d7e37af1 (diff)
downloadcurl-28b698858ca905bb9d1bf6f0b6f1557cbc4a7db5.tar.gz
opts docs: 3 more options in their own man pages
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_READDATA.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_READDATA.352
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_READDATA.3 b/docs/libcurl/opts/CURLOPT_READDATA.3
new file mode 100644
index 000000000..8a281d284
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_READDATA.3
@@ -0,0 +1,52 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2014, 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
+.\" * are also available at http://curl.haxx.se/docs/copyright.html.
+.\" *
+.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
+.\" * copies of the Software, and permit persons to whom the Software is
+.\" * furnished to do so, under the terms of the COPYING file.
+.\" *
+.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+.\" * KIND, either express or implied.
+.\" *
+.\" **************************************************************************
+.\"
+.TH CURLOPT_READDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
+.SH NAME
+CURLOPT_READDATA \- custom pointer passed to the read callback
+.SH SYNOPSIS
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer);
+.SH DESCRIPTION
+Data \fIpointer\fP to pass to the file read function. If you use the
+\fICURLOPT_READFUNCTION(3)\fP option, this is the pointer you'll get as
+input in the 4th argument to the callback.
+
+If you don't specify a read callback but instead rely on the default internal
+read function, this data must be a valid readable FILE * (cast to 'void *').
+
+If you're using libcurl as a win32 DLL, you MUST use a
+\fICURLOPT_READFUNCTION(3)\fP if you set this option.
+.SH DEFAULT
+By default, this is a FILE * to stdin.
+.SH PROTOCOLS
+This is used for all protocls when sending data.
+.SH EXAMPLE
+TODO
+.SH AVAILABILITY
+This option was once known by the older name \fICURLOPT_INFILE\fP, the name
+\fICURLOPT_READDATA\fP was introduced in 7.9.7.
+.SH RETURN VALUE
+This will return CURLE_OK.
+.SH "SEE ALSO"
+.BR CURLOPT_READFUNCTION "(3), " CURLOPT_WRITEDATA "(3), "