Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_CHUNK_END_FUNCTION.3

raw
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_END_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_CHUNK_END_FUNCTION \- callback after a transfer with FTP wildcardmatch
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 long chunk_end_callback(void *ptr);
31
32 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION,
33 chunk_end_callback);
34 .SH DESCRIPTION
35 Pass a pointer to your callback function, which should match the prototype
36 shown above.
37
38 This function gets called by libcurl as soon as a part of the stream has been
39 transferred (or skipped).
40
41 Return \fICURL_CHUNK_END_FUNC_OK\fP if everything is fine or
42 \fBCURL_CHUNK_END_FUNC_FAIL\fP to tell the lib to stop if some error occurred.
43 .SH DEFAULT
44 NULL
45 .SH PROTOCOLS
46 FTP
47 .SH EXAMPLE
48 .nf
49 static long file_is_downloaded(struct callback_data *data)
50 {
51 if(data->output) {
52 fclose(data->output);
53 data->output = 0x0;
54 }
55 return CURL_CHUNK_END_FUNC_OK;
56 }
57
58 int main()
59 {
60 /* data for callback */
61 struct callback_data callback_info;
62 curl_easy_setopt(curl, CURLOPT_CHUNK_END_FUNCTION, file_is_downloaded);
63 curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info);
64 }
65 .fi
66 .SH AVAILABILITY
67 Added in 7.21.0
68 .SH RETURN VALUE
69 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
70 .SH "SEE ALSO"
71 .BR CURLOPT_WILDCARDMATCH "(3), " CURLOPT_CHUNK_BGN_FUNCTION "(3), "