Skip to content

Commit

Permalink
docs: clarify CURLOPT_MAXFILESIZE and CURLOPT_MAXFILESIZE_LARGE
Browse files Browse the repository at this point in the history
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 curl#13372
  • Loading branch information
the-blank-x authored and bagder committed Apr 15, 2024
1 parent 5e46c29 commit e1f1ec0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 5 additions & 2 deletions docs/libcurl/opts/CURLOPT_MAXFILESIZE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
Expand All @@ -40,7 +42,7 @@ threshold.
# DEFAULT
None
0, meaning disabled.
# EXAMPLE
Expand All @@ -64,4 +66,5 @@ Always

# RETURN VALUE

Returns CURLE_OK
Returns CURLE_OK if the size passed is valid or CURLE_BAD_FUNCTION_ARGUMENT if
not.
8 changes: 5 additions & 3 deletions docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*
(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.
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
Expand All @@ -42,7 +43,7 @@ threshold.
# DEFAULT
None
0, meaning disabled.
# EXAMPLE
Expand All @@ -67,4 +68,5 @@ Added in 7.11.0

# 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.

0 comments on commit e1f1ec0

Please sign in to comment.