Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_READDATA.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_READDATA 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_READDATA \- custom pointer passed to the read callback
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer);
31: .SH DESCRIPTION
32: Data \fIpointer\fP to pass to the file read function. If you use the
33: \fICURLOPT_READFUNCTION(3)\fP option, this is the pointer you'll get as
34: input in the 4th argument to the callback.
35:
36: If you don't specify a read callback but instead rely on the default internal
37: read function, this data must be a valid readable FILE * (cast to 'void *').
38:
39: If you're using libcurl as a win32 DLL, you \fBMUST\fP use a
40: \fICURLOPT_READFUNCTION(3)\fP if you set this option or you will experience
41: crashes.
42: .SH DEFAULT
43: By default, this is a FILE * to stdin.
44: .SH PROTOCOLS
45: This is used for all protocols when sending data.
46: .SH EXAMPLE
47: .nf
48: CURL *curl = curl_easy_init();
49: struct MyData this;
50: if(curl) {
51: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
52:
53: /* pass pointer that gets passed in to the
54: CURLOPT_READFUNCTION callback */
55: curl_easy_setopt(curl, CURLOPT_READDATA, &this);
56:
57: curl_easy_perform(curl);
58: }
59: .fi
60: .SH AVAILABILITY
61: This option was once known by the older name CURLOPT_INFILE, the name
62: \fICURLOPT_READDATA(3)\fP was introduced in 7.9.7.
63: .SH RETURN VALUE
64: This will return CURLE_OK.
65: .SH "SEE ALSO"
66: .BR CURLOPT_READFUNCTION "(3), " CURLOPT_WRITEDATA "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>