Return to CURLOPT_CHUNK_END_FUNCTION.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CHUNK_END_FUNCTION.3, revision 1.1

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