Return to CURLOPT_INFILESIZE.3 CVS log

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

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

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, 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_INFILESIZE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_INFILESIZE \- set size of the input file to send off
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE, long filesize);
        !            31: .SH DESCRIPTION
        !            32: When uploading a file to a remote site, \fIfilesize\fP should be used to tell
        !            33: libcurl what the expected size of the input file is. This value must be passed
        !            34: as a long. See also \fICURLOPT_INFILESIZE_LARGE(3)\fP for sending files larger
        !            35: than 2GB.
        !            36: 
        !            37: For uploading using SCP, this option or \fICURLOPT_INFILESIZE_LARGE(3)\fP is
        !            38: mandatory.
        !            39: 
        !            40: To unset this value again, set it to -1.
        !            41: 
        !            42: When sending emails using SMTP, this command can be used to specify the
        !            43: optional SIZE parameter for the MAIL FROM command.
        !            44: 
        !            45: This option does not limit how much data libcurl will actually send, as that
        !            46: is controlled entirely by what the read callback returns, but telling one
        !            47: value and sending a different amount may lead to errors.
        !            48: .SH DEFAULT
        !            49: Unset
        !            50: .SH PROTOCOLS
        !            51: Many
        !            52: .SH EXAMPLE
        !            53: .nf
        !            54: CURL *curl = curl_easy_init();
        !            55: if(curl) {
        !            56:   long uploadsize = FILE_SIZE;
        !            57: 
        !            58:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/destination.tar.gz");
        !            59: 
        !            60:   curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
        !            61: 
        !            62:   curl_easy_setopt(curl, CURLOPT_INFILESIZE, uploadsize);
        !            63: 
        !            64:   curl_easy_perform(curl);
        !            65: }
        !            66: .fi
        !            67: .SH AVAILABILITY
        !            68: SMTP support added in 7.23.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_INFILESIZE_LARGE "(3), " CURLOPT_UPLOAD "(3), "