Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_MAXFILESIZE_LARGE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_MAXFILESIZE_LARGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_MAXFILESIZE_LARGE \- maximum file size allowed to download
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
31                           curl_off_t size);
32 .SH DESCRIPTION
33 Pass a curl_off_t as parameter. This allows you to specify the maximum
34 \fIsize\fP (in bytes) of a file to download. If the file requested is found
35 larger than this value, the transfer will not start and
36 \fICURLE_FILESIZE_EXCEEDED\fP will be returned.
37
38 The file size is not always known prior to download, and for such files this
39 option has no effect even if the file transfer ends up being larger than this
40 given limit. This concerns both FTP and HTTP transfers.
41 .SH DEFAULT
42 None
43 .SH PROTOCOLS
44 FTP and HTTP
45 .SH EXAMPLE
46 TODO
47 .SH AVAILABILITY
48 Added in 7.11.0
49 .SH RETURN VALUE
50 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
51 .SH "SEE ALSO"
52 .BR CURLOPT_MAXFILESIZE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "