123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2021, 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_INFILESIZE_LARGE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_INFILESIZE_LARGE \- size of the input file to send off
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE_LARGE,
- curl_off_t filesize);
- .SH DESCRIPTION
- When uploading a file to a remote site, \fIfilesize\fP should be used to tell
- libcurl what the expected size of the input file is. This value must be passed
- as a \fBcurl_off_t\fP.
- For uploading using SCP, this option or \fICURLOPT_INFILESIZE(3)\fP is
- mandatory.
- To unset this value again, set it to -1.
- When sending emails using SMTP, this command can be used to specify the
- optional SIZE parameter for the MAIL FROM command.
- This option does not limit how much data libcurl will actually send, as that
- is controlled entirely by what the read callback returns, but telling one
- value and sending a different amount may lead to errors.
- .SH DEFAULT
- Unset
- .SH PROTOCOLS
- Many
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_off_t uploadsize = FILE_SIZE;
- curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/destination.tar.gz");
- curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
- curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, uploadsize);
- curl_easy_perform(curl);
- }
- .fi
- .SH AVAILABILITY
- SMTP support added in 7.23.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH "SEE ALSO"
- .BR CURLOPT_INFILESIZE "(3), " CURLOPT_UPLOAD "(3), "
|