2
0

CURLINFO_CONTENT_LENGTH_DOWNLOAD.3 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLINFO_CONTENT_LENGTH_DOWNLOAD 3 "1 Sep 2015" "libcurl" "libcurl"
  26. .SH NAME
  27. CURLINFO_CONTENT_LENGTH_DOWNLOAD \- get content-length of download
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD,
  32. double *content_length);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a double to receive the content-length of the download. This
  36. is the value read from the Content-Length: field. Since 7.19.4, this returns
  37. -1 if the size is not known.
  38. \fICURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
  39. sensible variable type.
  40. .SH PROTOCOLS
  41. HTTP(S)
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  47. /* Perform the request */
  48. res = curl_easy_perform(curl);
  49. if(!res) {
  50. /* check the size */
  51. double cl;
  52. res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &cl);
  53. if(!res) {
  54. printf("Size: %.0f\\n", cl);
  55. }
  56. }
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Added in 7.6.1. Deprecated since 7.55.0.
  61. .SH RETURN VALUE
  62. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  63. .SH "SEE ALSO"
  64. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  65. .BR CURLINFO_CONTENT_LENGTH_UPLOAD "(3), "