manpagez: man pages & more
man CURLOPT_MAXFILESIZE_LARGE(3)
Home | html | info | man
CURLOPT_MAXFILESIZE_LARGE(3)                          Library Functions Manual


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 specifies the maximum accepted
       size (in bytes) of a file to download. If the file requested is found
       larger than this value, the transfer is aborted and
       CURLE_FILESIZE_EXCEEDED is returned. Passing a zero size disables this,
       and passing a negative size yields a CURLE_BAD_FUNCTION_ARGUMENT.

       The file size is not always known prior to the download start, and for
       such transfers this option has no effect - even if the file transfer
       eventually ends up being larger than this given limit.

       Since 8.4.0, this option also stops ongoing transfers if they reach
       this threshold.


DEFAULT

       0, meaning disabled.


PROTOCOLS

       This functionality affects ftp, http and mqtt


EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode ret;
           curl_off_t ridiculous = (curl_off_t)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 curl 7.11.0


RETURN VALUE

       Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if
       not, or CURLE_BAD_FUNCTION_ARGUMENT if the size passed is invalid.


SEE ALSO

       CURLOPT_MAXFILESIZE(3), CURLOPT_MAX_RECV_SPEED_LARGE(3)

libcurl                           2024-08-05      CURLOPT_MAXFILESIZE_LARGE(3)

curl 8.9.1 - Generated Tue Aug 6 18:03:03 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.