mirror of
https://github.com/moparisthebest/curl
synced 2024-08-13 17:03:50 -04:00
ecf0225461
Also make it clearer that the caveat 'if the file size is unknown it the option will have no effect' may apply to protocols other than FTP and HTTP. Reported-by: Josh Soref Fixes https://github.com/curl/curl/issues/7453
63 lines
2.4 KiB
Groff
63 lines
2.4 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_MAXFILESIZE_LARGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.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);
|
|
.SH DESCRIPTION
|
|
Pass a curl_off_t as parameter. This allows you to specify the maximum
|
|
\fIsize\fP (in bytes) of a file to download. If the file requested is found
|
|
larger than this value, the transfer will not start and
|
|
\fICURLE_FILESIZE_EXCEEDED\fP will be returned.
|
|
|
|
For protocols where the size is not known in advance (including FTP and HTTP)
|
|
this option has no effect even if the file transfer ends up being larger than
|
|
the given limit.
|
|
.SH DEFAULT
|
|
None
|
|
.SH PROTOCOLS
|
|
FTP, HTTP and MQTT
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.11.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_MAXFILESIZE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "
|