curlopt_chunk_bgn_function(3) [mojave man page]

CURLOPT_CHUNK_BGN_FUNCTION(3)				     curl_easy_setopt options				     CURLOPT_CHUNK_BGN_FUNCTION(3)

NAME

       CURLOPT_CHUNK_BGN_FUNCTION - callback before a transfer with FTP wildcardmatch

SYNOPSIS

       #include <curl/curl.h>

       long chunk_bgn_callback(const void *transfer_info, void *ptr,
			       int remains);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION,
				 chunk_bgn_callback);

DESCRIPTION

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

       This callback function gets called by libcurl before a part of the stream is going to be transferred (if the transfer supports chunks).

       The transfer_info pointer will point to a struct curl_fileinfo with details about the file that is about to get transferred.

       This callback makes sense only when using the CURLOPT_WILDCARDMATCH(3) option for now.

       The  target of transfer_info parameter is a "feature depended" structure. For the FTP wildcard download, the target is curl_fileinfo struc-
       ture (see curl/curl.h).	The parameter ptr is a pointer given by CURLOPT_CHUNK_DATA(3). The parameter remains  contains	number	of  chunks
       remaining per the transfer. If the feature is not available, the parameter has zero value.

       Return	CURL_CHUNK_BGN_FUNC_OK	 if   everything   is	fine,  CURL_CHUNK_BGN_FUNC_SKIP  if  you  want	to  skip  the  concrete  chunk	or
       CURL_CHUNK_BGN_FUNC_FAIL to tell libcurl to stop if some error occurred.

DEFAULT

       NULL

PROTOCOLS

       FTP

EXAMPLE

       TODO

AVAILABILITY

       This was added in 7.21.0

RETURN VALUE

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

SEE ALSO

       CURLOPT_CHUNK_END_FUNCTION(3), CURLOPT_WILDCARDMATCH(3),

libcurl 7.54.0							 February 03, 2016				     CURLOPT_CHUNK_BGN_FUNCTION(3)

CURLOPT_CONV_FROM_UTF8_FUNCTION(3)			     curl_easy_setopt options				CURLOPT_CONV_FROM_UTF8_FUNCTION(3)

NAME

       CURLOPT_CONV_FROM_UTF8_FUNCTION - convert data from UTF8 to host encoding

SYNOPSIS

       #include <curl/curl.h>

       CURLcode conv_callback(char *ptr, size_t length);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_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_FROM_UTF8_FUNCTION converts to host encoding from UTF8 encoding. It is required only for SSL processing.

       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

       TLS-based protocols.

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_TO_NETWORK_FUNCTION(3), CURLOPT_CONV_FROM_NETWORK_FUNCTION(3),

libcurl 7.54.0							 February 03, 2016				CURLOPT_CONV_FROM_UTF8_FUNCTION(3)