AP05/curl_arm64/share/man/man3/CURLOPT_CHUNK_END_FUNCTION.3
2025-12-02 13:06:35 +08:00

66 lines
1.6 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_CHUNK_END_FUNCTION.md
.TH CURLOPT_CHUNK_END_FUNCTION 3 "2025-07-07" libcurl
.SH NAME
CURLOPT_CHUNK_END_FUNCTION \- callback after a transfer with FTP wildcard match
.SH SYNOPSIS
.nf
#include <curl/curl.h>
long chunk_end_callback(void *ptr);
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION,
chunk_end_callback);
.fi
.SH DESCRIPTION
Pass a pointer to your callback function, which should match the prototype
shown above.
This function gets called by libcurl as soon as a part of the stream has been
transferred (or skipped).
Return \fICURL_CHUNK_END_FUNC_OK\fP if everything is fine or
\fBCURL_CHUNK_END_FUNC_FAIL\fP to tell the lib to stop if some error occurred.
.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_downloaded(void *ptr)
{
struct callback_data *data = ptr;
if(data->output) {
fclose(data->output);
data->output = 0x0;
}
return CURL_CHUNK_END_FUNC_OK;
}
int main()
{
/* data for callback */
struct callback_data callback_info;
CURL *curl = curl_easy_init();
curl_easy_setopt(curl, CURLOPT_CHUNK_END_FUNCTION, file_is_downloaded);
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)