curl / libcurl / API / curl_easy_setopt / CURLOPT_INFILESIZE

CURLOPT_INFILESIZE explained

Name

CURLOPT_INFILESIZE - size of the input file to send off

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE, long 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 long. See also CURLOPT_INFILESIZE_LARGE for sending files larger than 2GB.

For uploading using SCP, this option or CURLOPT_INFILESIZE_LARGE is mandatory.

To unset this value again, set it to -1.

Using CURLOPT_UPLOAD to an HTTP/1.1 server and this value set to -1, makes libcurl do a chunked transfer-encoded upload.

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 12345L
 
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    long 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, uploadsize);
 
    curl_easy_perform(curl);
  }
}

History

SMTP support added in 7.23.0

Availability

Added in curl 7.1

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.