Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_MAXFILESIZE_LARGE (3)

Name

CURLOPT_MAXFILESIZE_LARGE - maximum file size allowed to download

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
curl_off_t size);

Description

curl_easy_setopt options                          CURLOPT_MAXFILESIZE_LARGE(3)



NAME
       CURLOPT_MAXFILESIZE_LARGE - maximum file size allowed to download

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
                                 curl_off_t size);

DESCRIPTION
       Pass  a curl_off_t as parameter. This allows you to specify the maximum
       size (in bytes) of a file to download. If the file requested  is  found
       larger  than  this  value,  the transfer will not start and CURLE_FILE-
       SIZE_EXCEEDED will be returned.

       The file size is not always known prior to download, and for such files
       this  option  has  no  effect  even  if the file transfer ends up being
       larger than this given limit. This concerns both FTP  and  HTTP  trans-
       fers.

DEFAULT
       None

PROTOCOLS
       FTP and HTTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode ret;
         curl_off_t ridiculous = 1 << 48;
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         /* refuse to download if larger than ridiculous */
         curl_easy_setopt(curl, CURLOPT_MAXFILESIZE_LARGE, ridiculous);
         ret = curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.11.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_MAXFILESIZE(3), CURLOPT_MAX_RECV_SPEED_LARGE(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                    19 Jun 2014
                                                  CURLOPT_MAXFILESIZE_LARGE(3)