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