luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify CURLOPT_MAXFILESIZE and CURLOPT_MAXFILESIZE_LARGE

Browse Source 
The bounds of the size parameter were not specified, and nor was it
specified how to disable the maximum file size check.

The documentation also incorrectly stated that CURLOPT_MAXFILESIZE
always returns CURLE_OK and that CURLOPT_MAXFILESIZE_LARGE only returns
CURLE_OK or CURLE_UNKNOWN_OPTION.

It also did not mention what the default value is, which is zero. This
commit updates the documentation to make note of all these things.

Closes #13372
This commit is contained in:
blankie 2024-04-15 19:35:14 +10:00 committed by Daniel Stenberg
parent 5e46c2909f
commit e1f1ec028a
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/libcurl/opts/CURLOPT_MAXFILESIZE.md
View File

@ -28,6 +28,8 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE, long size);
Pass a long as parameter. This specifies the maximum accepted *size* (in Pass a long as parameter. This specifies the maximum accepted *size* (in
bytes) of a file to download. If the file requested is found larger than this 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. 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 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 transfers this option has no effect - even if the file transfer eventually
@ -40,7 +42,7 @@ threshold.
# DEFAULT # DEFAULT
None 0, meaning disabled.
# EXAMPLE # EXAMPLE
@ -64,4 +66,5 @@ Always
# RETURN VALUE # RETURN VALUE
Returns CURLE_OK Returns CURLE_OK if the size passed is valid or CURLE_BAD_FUNCTION_ARGUMENT if
not.

8
docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.md
View File

@ -31,7 +31,8 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
Pass a curl_off_t as parameter. This specifies the maximum accepted *size* 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 (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 this value, the transfer is aborted and *CURLE_FILESIZE_EXCEEDED* is
returned. 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 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 transfers this option has no effect - even if the file transfer eventually
@ -42,7 +43,7 @@ threshold.
# DEFAULT # DEFAULT
None 0, meaning disabled.
# EXAMPLE # EXAMPLE
@ -67,4 +68,5 @@ Added in 7.11.0
# RETURN VALUE # RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_BAD_FUNCTION_ARGUMENT if the size passed is invalid.