docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD_T.3

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