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