Blame view

3rdparty/curl/share/man/man3/CURLOPT_CHUNK_DATA.3 2.82 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, 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.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_CHUNK_DATA 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_CHUNK_DATA \- custom pointer to the FTP chunk callbacks
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer);
  .SH DESCRIPTION
  Pass a \fIpointer\fP that will be 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), " CURLOPT_WILDCARDMATCH "(3), "