Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD_T.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_T 3 "25 May 2017" "libcurl 7.55.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_CONTENT_LENGTH_DOWNLOAD_T \- 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_T,
30 curl_off_t *content_length);
31 .SH DESCRIPTION
32 Pass a pointer to a \fIcurl_off_t\fP to receive the content-length of the
33 download. This is the value read from the Content-Length: field. Stores -1 if
34 the size isn't known.
35 .SH PROTOCOLS
36 HTTP(S)
37 .SH EXAMPLE
38 .nf
39 CURL *curl = curl_easy_init();
40 if(curl) {
41 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
42
43 /* Perform the request */
44 res = curl_easy_perform(curl);
45
46 if(!res) {
47 /* check the size */
48 curl_off_t cl;
49 res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &cl);
50 if(!res) {
51 printf("Download size: %" CURL_FORMAT_CURL_OFF_T "\\n", cl);
52 }
53 }
54 }
55 .fi
56 .SH AVAILABILITY
57 Added in 7.55.0
58 .SH RETURN VALUE
59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60 .SH "SEE ALSO"
61 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
62 .BR CURLINFO_CONTENT_LENGTH_UPLOAD_T "(3), "