docs/libcurl/opts/CURLOPT_CHUNK_END_FUNCTION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, 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 http://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 TODO
  49 .SH AVAILABILITY
  50 Added in 7.21.0
  51 .SH RETURN VALUE
  52 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_WILDCARDMATCH "(3), " CURLOPT_CHUNK_BGN_FUNCTION "(3), "