Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_READDATA (3)

Name

CURLOPT_READDATA - pointer passed to the read callback

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer);

Description

CURLOPT_READDATA(3)        curl_easy_setopt options        CURLOPT_READDATA(3)



NAME
       CURLOPT_READDATA - pointer passed to the read callback

SYNOPSIS
       #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 CUR-
       LOPT_READFUNCTION(3) option, this is the pointer you will get as  input
       in the 4th 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 win32 DLL, you MUST use a CURLOPT_READ-
       FUNCTION(3) if you set this option or you will experience crashes.

DEFAULT
       By default, this is a FILE * to stdin.

PROTOCOLS
       This is used for all protocols when sending data.

EXAMPLE
       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);
       }

AVAILABILITY
       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 will return CURLE_OK.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_READFUNCTION(3), CURLOPT_WRITEDATA(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021           CURLOPT_READDATA(3)