Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_CHUNK_END_FUNCTION (3)

Name

CURLOPT_CHUNK_END_FUNCTION - cardmatch

Synopsis

#include <curl/curl.h>

long chunk_end_callback(void *ptr);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION,
chunk_end_callback);

Description

curl_easy_setopt options                         CURLOPT_CHUNK_END_FUNCTION(3)



NAME
       CURLOPT_CHUNK_END_FUNCTION  -  callback after a transfer with FTP wild-
       cardmatch

SYNOPSIS
       #include <curl/curl.h>

       long chunk_end_callback(void *ptr);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION,
                                 chunk_end_callback);

DESCRIPTION
       Pass a pointer to your callback function, which should match the proto-
       type shown above.

       This  function  gets  called by libcurl as soon as a part of the stream
       has been transferred (or skipped).

       Return   CURL_CHUNK_END_FUNC_OK    if    everything    is    fine    or
       CURL_CHUNK_END_FUNC_FAIL  to  tell  the  lib  to  stop  if  some  error
       occurred.

DEFAULT
       NULL

PROTOCOLS
       FTP

EXAMPLE
       static long file_is_downloaded(struct callback_data *data)
       {
         if(data->output) {
           fclose(data->output);
           data->output = 0x0;
         }
         return CURL_CHUNK_END_FUNC_OK;
       }

       int main()
       {
         /* data for callback */
         struct callback_data callback_info;
         curl_easy_setopt(curl, CURLOPT_CHUNK_END_FUNCTION, file_is_downloaded);
         curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info);
       }

AVAILABILITY
       Added in 7.21.0

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


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_WILDCARDMATCH(3), CURLOPT_CHUNK_BGN_FUNCTION(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

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



libcurl 7.37.0                    19 Jun 2014
                                                 CURLOPT_CHUNK_END_FUNCTION(3)