Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_WRITEDATA (3)

Name

CURLOPT_WRITEDATA - pointer passed to the write callback

Synopsis

#include <curl/curl.h>

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

Description

CURLOPT_WRITEDATA(3)       curl_easy_setopt options       CURLOPT_WRITEDATA(3)



NAME
       CURLOPT_WRITEDATA - pointer passed to the write callback

SYNOPSIS
       #include <curl/curl.h>

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

DESCRIPTION
       A  data  pointer  to  pass  to  the write callback. If you use the CUR-
       LOPT_WRITEFUNCTION(3) option, this is the pointer you will get in  that
       callback's  4th  argument. If you do not use a write callback, you must
       make pointer a 'FILE *' (cast to 'void *') as libcurl will pass this to
       fwrite(3) when writing data.

       The internal CURLOPT_WRITEFUNCTION(3) will write the data to the FILE *
       given with this option, or to stdout if this option has not been set.

       If you are using libcurl as a win32 DLL, you MUST use a  CURLOPT_WRITE-
       FUNCTION(3) if you set this option or you will experience crashes.

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

PROTOCOLS
       Used for all protocols.

EXAMPLE
       A  common  technique is to use the write callback to store the incoming
       data into a dynamically growing allocated buffer, and  then  this  CUR-
       LOPT_WRITEDATA(3)  is  used to point to a struct or the buffer to store
       data      in.      Like      in      the      getinmemory      example:
       https://curl.se/libcurl/c/getinmemory.html

AVAILABILITY
       Available  in  all  libcurl versions. This option was formerly known as
       CURLOPT_FILE, the name CURLOPT_WRITEDATA(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_WRITEFUNCTION(3), CURLOPT_READDATA(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_WRITEDATA(3)