docs/libcurl/opts/CURLOPT_MAXFILESIZE.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 http://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 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_MAXFILESIZE \- maximum file size allowed to download
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE, long size);
  30 .SH DESCRIPTION
  31 Pass a long as parameter. This allows you to specify the maximum \fIsize\fP
  32 (in bytes) of a file to download. If the file requested is found larger than
  33 this value, the transfer will not start and \fICURLE_FILESIZE_EXCEEDED\fP will
  34 be returned.
  35
  36 The file size is not always known prior to download, and for such files this
  37 option has no effect even if the file transfer ends up being larger than this
  38 given limit. This concerns both FTP and HTTP transfers.
  39
  40 If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP.
  41 .SH DEFAULT
  42 None
  43 .SH PROTOCOLS
  44 FTP and HTTP
  45 .SH EXAMPLE
  46 TODO
  47 .SH AVAILABILITY
  48 Always
  49 .SH RETURN VALUE
  50 Returns CURLE_OK
  51 .SH "SEE ALSO"
  52 .BR CURLOPT_MAXFILESIZE_LARGE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "