curl / libcurl / API / curl_easy_setopt / CURLOPT_INFILESIZE_LARGE

CURLOPT_INFILESIZE_LARGE explained

Name

CURLOPT_INFILESIZE_LARGE - size of the input file to send off

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE_LARGE,
                          curl_off_t filesize);

Description

When uploading a file to a remote site, filesize should be used to tell libcurl what the expected size of the input file is. This value must be passed as a curl_off_t.

For uploading using SCP, this option or CURLOPT_INFILESIZE 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.

Default

Unset

Protocols

This functionality affects all supported protocols

Example

#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);
  }
}

History

SMTP support added in 7.23.0

Availability

Added in curl 7.11.0

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.