docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_MAXFILESIZE_LARGE man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 P.level0 {
   8  padding-left: 2em;
   9 }
  10
  11 P.level1 {
  12  padding-left: 4em;
  13 }
  14
  15 P.level2 {
  16  padding-left: 6em;
  17 }
  18
  19 span.emphasis {
  20  font-style: italic;
  21 }
  22
  23 span.bold {
  24  font-weight: bold;
  25 }
  26
  27 span.manpage {
  28  font-weight: bold;
  29 }
  30
  31 h2.nroffsh {
  32  background-color: #e0e0e0;
  33 }
  34
  35 span.nroffip {
  36  font-weight: bold;
  37  font-size: 120%;
  38  font-family: monospace;
  39 }
  40
  41 p.roffit {
  42  text-align: center;
  43  font-size: 80%;
  44 }
  45 </STYLE>
  46 </head><body>
  47
  48 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  49 <p class="level0">CURLOPT_MAXFILESIZE_LARGE - maximum file size allowed to download <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  50 <p class="level0"><pre>
  51 <p class="level0">#include &lt;curl/curl.h&gt;
  52  <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
  53  &nbsp;                         curl_off_t size);
  54  </pre>
  55 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  56 <p class="level0">Pass a curl_off_t as parameter. This allows you to specify the maximum <span Class="emphasis">size</span> (in bytes) of a file to download. If the file requested is found larger than this value, the transfer will not start and <span Class="emphasis">CURLE_FILESIZE_EXCEEDED</span> will be returned.
  57 <p class="level0">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. This concerns both FTP and HTTP transfers. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  58 <p class="level0">None <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  59 <p class="level0">FTP and HTTP <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  60 <p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  61 <p class="level0">Added in 7.11.0 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  62 <p class="level0">Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  63 <p class="level0"><a Class="manpage" href="./CURLOPT_MAXFILESIZE.html">CURLOPT_MAXFILESIZE</a>, <a Class="manpage" href="./CURLOPT_MAX_RECV_SPEED_LARGE.html">CURLOPT_MAX_RECV_SPEED_LARGE</a>, <span Class="manpage"> </span> <p class="roffit">
  64  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  65 </body></html>