Return to CURLOPT_INFILESIZE_LARGE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_INFILESIZE_LARGE.3, revision 1.1.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_LARGE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_INFILESIZE_LARGE \- set size of the input file to send off
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE_LARGE,
                     32:                           curl_off_t filesize);
                     33: .SH DESCRIPTION
                     34: When uploading a file to a remote site, \fIfilesize\fP should be used to tell
                     35: libcurl what the expected size of the input file is. This value must be passed
                     36: as a \fBcurl_off_t\fP.
                     37: 
                     38: For uploading using SCP, this option or \fICURLOPT_INFILESIZE(3)\fP is
                     39: mandatory.
                     40: 
                     41: To unset this value again, set it to -1.
                     42: 
                     43: When sending emails using SMTP, this command can be used to specify the
                     44: optional SIZE parameter for the MAIL FROM command.
                     45: 
                     46: This option does not limit how much data libcurl will actually send, as that
                     47: is controlled entirely by what the read callback returns, but telling one
                     48: value and sending a different amount may lead to errors.
                     49: .SH DEFAULT
                     50: Unset
                     51: .SH PROTOCOLS
                     52: Many
                     53: .SH EXAMPLE
                     54: .nf
                     55: CURL *curl = curl_easy_init();
                     56: if(curl) {
                     57:   curl_off_t uploadsize = FILE_SIZE;
                     58: 
                     59:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/destination.tar.gz");
                     60: 
                     61:   curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
                     62: 
                     63:   curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, uploadsize);
                     64: 
                     65:   curl_easy_perform(curl);
                     66: }
                     67: .fi
                     68: .SH AVAILABILITY
                     69: SMTP support added in 7.23.0
                     70: .SH RETURN VALUE
                     71: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     72: .SH "SEE ALSO"
                     73: .BR CURLOPT_INFILESIZE "(3), " CURLOPT_UPLOAD "(3), "