CURLOPT_MAXFILESIZE_LARGE.3 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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.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. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE,
  30. curl_off_t size);
  31. .SH DESCRIPTION
  32. Pass a curl_off_t as parameter. This allows you to specify the maximum
  33. \fIsize\fP (in bytes) of a file to download. If the file requested is found
  34. larger than this value, the transfer will not start and
  35. \fICURLE_FILESIZE_EXCEEDED\fP will be returned.
  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.
  39. .SH DEFAULT
  40. None
  41. .SH PROTOCOLS
  42. FTP, HTTP and MQTT
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. CURLcode ret;
  48. curl_off_t ridiculous = 1 << 48;
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  50. /* refuse to download if larger than ridiculous */
  51. curl_easy_setopt(curl, CURLOPT_MAXFILESIZE_LARGE, ridiculous);
  52. ret = curl_easy_perform(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.11.0
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  59. .SH "SEE ALSO"
  60. .BR CURLOPT_MAXFILESIZE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), "