| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_CHUNK_DATA \- custom pointer to the FTP chunk callbacks |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a \fIpointer\fP that will be untouched by libcurl and passed as the ptr |
| 32 |
argument to the \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP and |
| 33 |
\fICURLOPT_CHUNK_END_FUNCTION(3)\fP. |
| 34 |
.SH DEFAULT |
| 35 |
NULL |
| 36 |
.SH PROTOCOLS |
| 37 |
FTP |
| 38 |
.SH EXAMPLE |
| 39 |
.nf |
| 40 |
static long file_is_coming(struct curl_fileinfo *finfo, |
| 41 |
struct callback_data *data, |
| 42 |
int remains) |
| 43 |
{ |
| 44 |
printf("%3d %40s %10luB ", remains, finfo->filename, |
| 45 |
(unsigned long)finfo->size); |
| 46 |
|
| 47 |
switch(finfo->filetype) { |
| 48 |
case CURLFILETYPE_DIRECTORY: |
| 49 |
printf(" DIR\\n"); |
| 50 |
break; |
| 51 |
case CURLFILETYPE_FILE: |
| 52 |
printf("FILE "); |
| 53 |
break; |
| 54 |
default: |
| 55 |
printf("OTHER\\n"); |
| 56 |
break; |
| 57 |
} |
| 58 |
|
| 59 |
if(finfo->filetype == CURLFILETYPE_FILE) { |
| 60 |
/* do not transfer files >= 50B */ |
| 61 |
if(finfo->size > 50) { |
| 62 |
printf("SKIPPED\\n"); |
| 63 |
return CURL_CHUNK_BGN_FUNC_SKIP; |
| 64 |
} |
| 65 |
|
| 66 |
data->output = fopen(finfo->filename, "wb"); |
| 67 |
if(!data->output) { |
| 68 |
return CURL_CHUNK_BGN_FUNC_FAIL; |
| 69 |
} |
| 70 |
} |
| 71 |
|
| 72 |
return CURL_CHUNK_BGN_FUNC_OK; |
| 73 |
} |
| 74 |
|
| 75 |
int main() |
| 76 |
{ |
| 77 |
/* data for callback */ |
| 78 |
struct callback_data callback_info; |
| 79 |
|
| 80 |
/* callback is called before download of concrete file started */ |
| 81 |
curl_easy_setopt(curl, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming); |
| 82 |
curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info); |
| 83 |
} |
| 84 |
.fi |
| 85 |
.SH AVAILABILITY |
| 86 |
Added in 7.21.0 |
| 87 |
.SH RETURN VALUE |
| 88 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 89 |
.SH "SEE ALSO" |
| 90 |
.BR CURLOPT_CHUNK_BGN_FUNCTION "(3), " CURLOPT_WILDCARDMATCH "(3), " |