85 lines
2.0 KiB
Groff
85 lines
2.0 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_CHUNK_DATA.md
|
||
|
|
.TH CURLOPT_CHUNK_DATA 3 "2025-07-07" libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_CHUNK_DATA \- pointer passed to the FTP chunk callbacks
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a \fIpointer\fP that is untouched by libcurl and passed as the ptr
|
||
|
|
argument to the \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP and
|
||
|
|
\fICURLOPT_CHUNK_END_FUNCTION(3)\fP.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
This functionality affects ftp only
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
#include <stdio.h>
|
||
|
|
|
||
|
|
struct callback_data {
|
||
|
|
FILE *output;
|
||
|
|
};
|
||
|
|
|
||
|
|
static long file_is_coming(struct curl_fileinfo *finfo,
|
||
|
|
void *ptr,
|
||
|
|
int remains)
|
||
|
|
{
|
||
|
|
struct callback_data *data = ptr;
|
||
|
|
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;
|
||
|
|
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
|
||
|
|
/* 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);
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in curl 7.21.0
|
||
|
|
.SH RETURN VALUE
|
||
|
|
\fIcurl_easy_setopt(3)\fP returns a CURLcode indicating success or error.
|
||
|
|
|
||
|
|
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
|
||
|
|
\fIlibcurl\-errors(3)\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR CURLOPT_CHUNK_BGN_FUNCTION (3),
|
||
|
|
.BR CURLOPT_WILDCARDMATCH (3)
|