Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_CONTENT_LENGTH_DOWNLOAD.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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.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 .SH PROTOCOLS
36 HTTP(S)
37 .SH EXAMPLE
38 TODO
39 .SH AVAILABILITY
40 Added in 7.6.1
41 .SH RETURN VALUE
42 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
43 .SH "SEE ALSO"
44 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
45 .BR CURLINFO_CONTENT_LENGTH_UPLOAD "(3), "