docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_MAXFILESIZE_LARGE \- maximum file size allowed to download
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
  32                           curl_off_t size);
  33 .SH DESCRIPTION
  34 Pass a curl_off_t as parameter. This allows you to specify the maximum
  35 \fIsize\fP (in bytes) of a file to download. If the file requested is found
  36 larger than this value, the transfer will not start and
  37 \fICURLE_FILESIZE_EXCEEDED\fP will be returned.
  38
  39 The file size is not always known prior to download, and for such files this
  40 option has no effect even if the file transfer ends up being larger than this
  41 given limit. This concerns both FTP and HTTP transfers.
  42 .SH DEFAULT
  43 None
  44 .SH PROTOCOLS
  45 FTP and HTTP
  46 .SH EXAMPLE
  47 .nf
  48 CURL *curl = curl_easy_init();
  49 if(curl) {
  50   CURLcode ret;
  51   curl_off_t ridiculous = 1 << 48;
  52   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  53   /* refuse to download if larger than ridiculous */
  54   curl_easy_setopt(curl, CURLOPT_MAXFILESIZE_LARGE, ridiculous);
  55   ret = curl_easy_perform(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Added in 7.11.0
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_MAXFILESIZE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "