84 lines
2.5 KiB
Groff
84 lines
2.5 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_CHUNK_END_FUNCTION 3 "19 Jun 2014" libcurl 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);
|
||
|
|
.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
|
||
|
|
FTP
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
#include <stdio.h>
|
||
|
|
|
||
|
|
struct callback_data {
|
||
|
|
FILE *output;
|
||
|
|
};
|
||
|
|
|
||
|
|
static long file_is_downloaded(struct callback_data *data)
|
||
|
|
{
|
||
|
|
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 7.21.0
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_CHUNK_BGN_FUNCTION (3),
|
||
|
|
.BR CURLOPT_WILDCARDMATCH (3)
|