Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_INFILESIZE_LARGE (3)

Name

CURLOPT_INFILESIZE_LARGE - set 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

curl_easy_setopt options                           CURLOPT_INFILESIZE_LARGE(3)



NAME
       CURLOPT_INFILESIZE_LARGE - set 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(3) is manda-
       tory.

       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.

DEFAULT
       Unset

PROTOCOLS
       Many

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

AVAILABILITY
       SMTP support added in 7.23.0

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_INFILESIZE(3), CURLOPT_UPLOAD(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014
                                                   CURLOPT_INFILESIZE_LARGE(3)