docs/libcurl/opts/CURLOPT_CHUNK_DATA.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_CHUNK_DATA 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_CHUNK_DATA \- custom pointer to the FTP chunk callbacks
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer);
  31 .SH DESCRIPTION
  32 Pass a \fIpointer\fP that will be untouched by libcurl and passed as the ptr
  33 argument to the \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP and
  34 \fICURLOPT_CHUNK_END_FUNCTION(3)\fP.
  35 .SH DEFAULT
  36 NULL
  37 .SH PROTOCOLS
  38 FTP
  39 .SH EXAMPLE
  40 .nf
  41 static long file_is_coming(struct curl_fileinfo *finfo,
  42                            struct callback_data *data,
  43                            int remains)
  44 {
  45   printf("%3d %40s %10luB ", remains, finfo->filename,
  46          (unsigned long)finfo->size);
  47
  48   switch(finfo->filetype) {
  49   case CURLFILETYPE_DIRECTORY:
  50     printf(" DIR\n");
  51     break;
  52   case CURLFILETYPE_FILE:
  53     printf("FILE ");
  54     break;
  55   default:
  56     printf("OTHER\n");
  57     break;
  58   }
  59
  60   if(finfo->filetype == CURLFILETYPE_FILE) {
  61     /* do not transfer files >= 50B */
  62     if(finfo->size > 50) {
  63       printf("SKIPPED\n");
  64       return CURL_CHUNK_BGN_FUNC_SKIP;
  65     }
  66
  67     data->output = fopen(finfo->filename, "wb");
  68     if(!data->output) {
  69       return CURL_CHUNK_BGN_FUNC_FAIL;
  70     }
  71   }
  72
  73   return CURL_CHUNK_BGN_FUNC_OK;
  74 }
  75
  76 int main()
  77 {
  78   /* data for callback */
  79   struct callback_data callback_info;
  80
  81   /* callback is called before download of concrete file started */
  82   curl_easy_setopt(curl, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
  83   curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info);
  84 }
  85 .fi
  86 .SH AVAILABILITY
  87 Added in 7.21.0
  88 .SH RETURN VALUE
  89 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  90 .SH "SEE ALSO"
  91 .BR CURLOPT_CHUNK_BGN_FUNCTION "(3), " CURLOPT_WILDCARDMATCH "(3), "