• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_CONTENT_LENGTH_DOWNLOAD_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_CONTENT_LENGTH_UPLOAD_T (3)
9  - curl_easy_getinfo (3)
10  - curl_easy_setopt (3)
11---
12
13# NAME
14
15CURLINFO_CONTENT_LENGTH_DOWNLOAD_T - get content-length of download
16
17# SYNOPSIS
18
19~~~c
20#include <curl/curl.h>
21
22CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T,
23                           curl_off_t *content_length);
24~~~
25
26# DESCRIPTION
27
28Pass a pointer to a *curl_off_t* to receive the content-length of the
29download. This is the value read from the Content-Length: field. Stores -1 if
30the size is not known.
31
32# PROTOCOLS
33
34HTTP(S)
35
36# EXAMPLE
37
38~~~c
39int main(void)
40{
41  CURL *curl = curl_easy_init();
42  if(curl) {
43    CURLcode res;
44    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
45
46    /* Perform the request */
47    res = curl_easy_perform(curl);
48
49    if(!res) {
50      /* check the size */
51      curl_off_t cl;
52      res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &cl);
53      if(!res) {
54        printf("Download size: %" CURL_FORMAT_CURL_OFF_T "\n", cl);
55      }
56    }
57  }
58}
59~~~
60
61# AVAILABILITY
62
63Added in 7.55.0
64
65# RETURN VALUE
66
67Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
68