mirror of
https://github.com/curl/curl.git
synced 2026-08-08 03:22:55 +03:00
8c1d9378ac
- generate AVAILABILITY manpage sections automatically - for consistent wording - allows us to double-check against other documumentation (symbols-in-versions etc) - enables proper automation/scripting based on this data - lots of them were wrong or missing in the manpages - several of them repeated (sometimes mismatching) backend support info Add test 1488 to verify "added-in" version numbers against symbols-in-versions. Closes #14217
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_READDATA
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_HEADERDATA (3)
|
|
- CURLOPT_READFUNCTION (3)
|
|
- CURLOPT_WRITEDATA (3)
|
|
- CURLOPT_WRITEFUNCTION (3)
|
|
Protocol:
|
|
- All
|
|
Added-in: 7.9.7
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_READDATA - pointer passed to the read callback
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Data *pointer* to pass to the file read function. If you use the
|
|
CURLOPT_READFUNCTION(3) option, this is the pointer you get as input in
|
|
the fourth argument to the callback.
|
|
|
|
If you do not 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 are using libcurl as a DLL on Windows, you must use the
|
|
CURLOPT_READFUNCTION(3) callback if you set this option, otherwise you
|
|
might experience crashes.
|
|
|
|
# DEFAULT
|
|
|
|
By default, this is a FILE * to stdin.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
struct MyData {
|
|
void *custom;
|
|
};
|
|
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
struct MyData this;
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* pass pointer that gets passed in to the
|
|
CURLOPT_READFUNCTION callback */
|
|
curl_easy_setopt(curl, CURLOPT_READDATA, &this);
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# NOTES
|
|
|
|
This option was once known by the older name CURLOPT_INFILE, the name
|
|
CURLOPT_READDATA(3) was introduced in 7.9.7.
|
|
|
|
# RETURN VALUE
|
|
|
|
This returns CURLE_OK.
|