| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 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.
- .\" *
- .\" * SPDX-License-Identifier: curl
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_MAXFILESIZE 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_MAXFILESIZE \- maximum file size allowed to download
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE, long size);
- .fi
- .SH DESCRIPTION
- Pass a long 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.
- The file size is not always known prior to download, and for such files this
- option has no effect even if the file transfer ends up being larger than this
- given limit.
- If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP.
- .SH DEFAULT
- None
- .SH PROTOCOLS
- FTP, HTTP and MQTT
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode ret;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
- /* refuse to download if larger than 1000 bytes! */
- curl_easy_setopt(curl, CURLOPT_MAXFILESIZE, 1000L);
- ret = curl_easy_perform(curl);
- }
- .fi
- .SH AVAILABILITY
- Always
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH "SEE ALSO"
- .BR CURLOPT_MAXFILESIZE_LARGE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "
|
