mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
61 lines
1.6 KiB
Groff
61 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_INFILESIZE_LARGE.md
|
|
.TH CURLOPT_INFILESIZE_LARGE 3 "2024-06-01" libcurl
|
|
.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);
|
|
.fi
|
|
.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 actually sends, 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
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
#define FILE_SIZE 123456
|
|
|
|
int main(void)
|
|
{
|
|
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 CURLINFO_CONTENT_LENGTH_UPLOAD_T (3),
|
|
.BR CURLOPT_INFILESIZE (3),
|
|
.BR CURLOPT_UPLOAD (3)
|