curl/docs/libcurl/opts/CURLOPT_CHUNK_DATA.md
Daniel Stenberg e3fe020089
docs/libcurl: generate PROTOCOLS from meta-data
Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175
2024-03-23 18:13:03 +01:00

100 lines
1.9 KiB
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_CHUNK_DATA
Section: 3
Source: libcurl
See-also:
- CURLOPT_CHUNK_BGN_FUNCTION (3)
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
---
# NAME
CURLOPT_CHUNK_DATA - pointer passed to the FTP chunk callbacks
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer);
~~~
# DESCRIPTION
Pass a *pointer* that is untouched by libcurl and passed as the ptr
argument to the CURLOPT_CHUNK_BGN_FUNCTION(3) and
CURLOPT_CHUNK_END_FUNCTION(3).
# DEFAULT
NULL
# EXAMPLE
~~~c
#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);
}
~~~
# AVAILABILITY
Added in 7.21.0
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.