aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_CHUNK_DATA.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_CHUNK_DATA.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_CHUNK_DATA.395
1 files changed, 0 insertions, 95 deletions
diff --git a/docs/libcurl/opts/CURLOPT_CHUNK_DATA.3 b/docs/libcurl/opts/CURLOPT_CHUNK_DATA.3
deleted file mode 100644
index 785c010cf..000000000
--- a/docs/libcurl/opts/CURLOPT_CHUNK_DATA.3
+++ /dev/null
@@ -1,95 +0,0 @@
-.\" **************************************************************************
-.\" * _ _ ____ _
-.\" * 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_DATA 3 "19 Jun 2014" libcurl 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
-FTP
-.SH EXAMPLE
-.nf
-static long file_is_coming(struct curl_fileinfo *finfo,
- struct callback_data *data,
- int remains)
-{
- 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;
-
- /* 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 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)