mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
52 lines
1.7 KiB
Groff
52 lines
1.7 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_MAXFILESIZE_LARGE.md
|
|
.TH CURLOPT_MAXFILESIZE_LARGE 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_MAXFILESIZE_LARGE \- maximum file size allowed to download
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
|
|
curl_off_t size);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a curl_off_t as parameter. This specifies the maximum accepted \fIsize\fP
|
|
(in bytes) of a file to download. If the file requested is found larger than
|
|
this value, the transfer is aborted and \fICURLE_FILESIZE_EXCEEDED\fP is
|
|
returned. Passing a zero \fIsize\fP disables this, and passing a negative \fIsize\fP
|
|
yields a \fICURLE_BAD_FUNCTION_ARGUMENT\fP.
|
|
|
|
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.
|
|
.SH DEFAULT
|
|
0, meaning disabled.
|
|
.SH PROTOCOLS
|
|
FTP, HTTP and MQTT
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.11.0
|
|
.SH 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.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_MAXFILESIZE (3),
|
|
.BR CURLOPT_MAX_RECV_SPEED_LARGE (3)
|