curlopt_conv_to_network_function(3) [mojave man page]

CURLOPT_CONV_TO_NETWORK_FUNCTION(3)			     curl_easy_setopt options			       CURLOPT_CONV_TO_NETWORK_FUNCTION(3)

NAME

       CURLOPT_CONV_TO_NETWORK_FUNCTION - convert data to network from host encoding

SYNOPSIS

       #include <curl/curl.h>

       CURLcode conv_callback(char *ptr, size_t length);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_TO_NETWORK_FUNCTION,
				 conv_callback);

DESCRIPTION

       Pass a pointer to your callback function, which should match the prototype shown above.

       Applies to non-ASCII platforms. curl_version_info(3) will return the CURL_VERSION_CONV feature bit set if this option is provided.

       The  data to be converted is in a buffer pointed to by the ptr parameter.  The amount of data to convert is indicated by the length parame-
       ter.  The converted data overlays the input data in the buffer pointed to by the ptr parameter. CURLE_OK must be returned  upon	successful
       conversion.  A CURLcode return value defined by curl.h, such as CURLE_CONV_FAILED, should be returned if an error was encountered.

       CURLOPT_CONV_TO_NETWORK_FUNCTION converts from host encoding to the network encoding.  It is used when commands or ASCII data are sent over
       the network.

       If you set a callback pointer to NULL, or don't set it at all, the built-in libcurl iconv functions will be used.  If  HAVE_ICONV  was  not
       defined when libcurl was built, and no callback has been established, conversion will return the CURLE_CONV_REQD error code.

       If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined.  For example:

	#define CURL_ICONV_CODESET_OF_HOST "IBM-1047"

       The iconv code in libcurl will default the network and UTF8 codeset names as follows:

	#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1"

	#define CURL_ICONV_CODESET_FOR_UTF8   "UTF-8"

       You will need to override these definitions if they are different on your system.

DEFAULT

       NULL

PROTOCOLS

       FTP, SMTP, IMAP, POP3

EXAMPLE

       TODO

AVAILABILITY

       Available only if CURL_DOES_CONVERSIONS was defined when libcurl was built.

RETURN VALUE

       Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

SEE ALSO

       CURLOPT_CONV_FROM_NETWORK_FUNCTION(3), CURLOPT_CONV_FROM_UTF8_FUNCTION(3),

libcurl 7.54.0							   May 01, 2016 			       CURLOPT_CONV_TO_NETWORK_FUNCTION(3)

CURLOPT_WRITEFUNCTION(3)				     curl_easy_setopt options					  CURLOPT_WRITEFUNCTION(3)

NAME

       CURLOPT_WRITEFUNCTION - set callback for writing received data

SYNOPSIS

       #include <curl/curl.h>

       size_t write_callback(char *ptr, size_t size, size_t nmemb, void *userdata);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WRITEFUNCTION, write_callback);

DESCRIPTION

       Pass a pointer to your callback function, which should match the prototype shown above.

       This  callback function gets called by libcurl as soon as there is data received that needs to be saved.  ptr points to the delivered data,
       and the size of that data is size multiplied with nmemb.

       The callback function will be passed as much data as possible in all invokes, but you must not make any assumptions. It may be one byte, it
       may  be	thousands.  The  maximum  amount  of  body  data  that	will be passed to the write callback is defined in the curl.h header file:
       CURL_MAX_WRITE_SIZE (the usual default is 16K). If CURLOPT_HEADER(3) is enabled, which makes header data get passed to the write  callback,
       you can get up to CURL_MAX_HTTP_HEADER bytes of header data passed into it. This usually means 100K.

       This function may be called with zero bytes data if the transferred file is empty.

       The data passed to this function will not be zero terminated!

       Set the userdata argument with the CURLOPT_WRITEDATA(3) option.

       Your  callback  should  return  the  number of bytes actually taken care of. If that amount differs from the amount passed to your callback
       function, it'll signal an error condition to the library. This will cause the transfer to get aborted and the libcurl  function	used  will
       return CURLE_WRITE_ERROR.

       If  your  callback  function returns CURL_WRITEFUNC_PAUSE it will cause this transfer to become paused.	See curl_easy_pause(3) for further
       details.

       Set this option to NULL to get the internal default function used instead of your callback. The internal default function  will	write  the
       data to the FILE * given with CURLOPT_WRITEDATA(3).

DEFAULT

       libcurl will use 'fwrite' as a callback by default.

PROTOCOLS

       For all protocols

AVAILABILITY

       Support for the CURL_WRITEFUNC_PAUSE return code was added in version 7.18.0.

RETURN VALUE

       This will return CURLE_OK.

EXAMPLE

       A  common technique is to use this callback to store the incoming data into a dynamically growing allocated buffer. Like in the getinmemory
       example: https://curl.haxx.se/libcurl/c/getinmemory.html

SEE ALSO

       CURLOPT_WRITEDATA(3), CURLOPT_READFUNCTION(3),

libcurl 7.54.0							 February 03, 2016					  CURLOPT_WRITEFUNCTION(3)