Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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.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 CURLINFO_CONTENT_LENGTH_DOWNLOAD 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_CONTENT_LENGTH_DOWNLOAD \- get content-length of download
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD,
30 double *content_length);
31 .SH DESCRIPTION
32 Pass a pointer to a double to receive the content-length of the download. This
33 is the value read from the Content-Length: field. Since 7.19.4, this returns
34 -1 if the size isn't known.
35
36 \fICURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
37 sensible variable type.
38 .SH PROTOCOLS
39 HTTP(S)
40 .SH EXAMPLE
41 .nf
42 CURL *curl = curl_easy_init();
43 if(curl) {
44 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
45
46 /* Perform the request */
47 res = curl_easy_perform(curl);
48
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
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), "