Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_CHUNK_DATA (3)

Name

CURLOPT_CHUNK_DATA - pointer passed to the FTP chunk callbacks

Synopsis

#include <curl/curl.h>

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

Description

CURLOPT_CHUNK_DATA(3)      curl_easy_setopt options      CURLOPT_CHUNK_DATA(3)



NAME
       CURLOPT_CHUNK_DATA - pointer passed to the FTP chunk callbacks

SYNOPSIS
       #include <curl/curl.h>

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

DESCRIPTION
       Pass  a pointer that will be untouched by libcurl and passed as the ptr
       argument    to    the    CURLOPT_CHUNK_BGN_FUNCTION(3)     and     CUR-
       LOPT_CHUNK_END_FUNCTION(3).

DEFAULT
       NULL

PROTOCOLS
       FTP

EXAMPLE
       static long file_is_coming(struct curl_fileinfo *finfo,
                                  struct callback_data *data,
                                  int remains)
       {
         printf("%3d %40s %10luB ", remains, finfo->filename,
                (unsigned long)finfo->size);

         switch(finfo->filetype) {
         case CURLFILETYPE_DIRECTORY:
           printf(" DIR\n");
           break;
         case CURLFILETYPE_FILE:
           printf("FILE ");
           break;
         default:
           printf("OTHER\n");
           break;
         }

         if(finfo->filetype == CURLFILETYPE_FILE) {
           /* do not transfer files >= 50B */
           if(finfo->size > 50) {
             printf("SKIPPED\n");
             return CURL_CHUNK_BGN_FUNC_SKIP;
           }

           data->output = fopen(finfo->filename, "wb");
           if(!data->output) {
             return CURL_CHUNK_BGN_FUNC_FAIL;
           }
         }

         return CURL_CHUNK_BGN_FUNC_OK;
       }

       int main()
       {
         /* data for callback */
         struct callback_data callback_info;

         /* callback is called before download of concrete file started */
         curl_easy_setopt(curl, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
         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_CHUNK_BGN_FUNCTION(3), CURLOPT_WILDCARDMATCH(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_CHUNK_DATA(3)