Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SIZE_DOWNLOAD_T.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2020, 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_SIZE_DOWNLOAD_T 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
! 24:
! 25: .SH NAME
! 26: CURLINFO_SIZE_DOWNLOAD_T \- get the number of downloaded bytes
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD_T, curl_off_t *dlp);
! 31: .SH DESCRIPTION
! 32: Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
! 33: were downloaded. The amount is only for the latest transfer and will be reset
! 34: again for each new transfer. This counts actual payload data, what's also
! 35: commonly called body. All meta and header data are excluded and will not be
! 36: counted in this number.
! 37: .SH PROTOCOLS
! 38: All
! 39: .SH EXAMPLE
! 40: .nf
! 41: CURL *curl = curl_easy_init();
! 42: if(curl) {
! 43: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 44:
! 45: /* Perform the request */
! 46: res = curl_easy_perform(curl);
! 47:
! 48: if(!res) {
! 49: /* check the size */
! 50: curl_off_t dl;
! 51: res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD_T, &dl);
! 52: if(!res) {
! 53: printf("Downloaded %" CURL_FORMAT_CURL_OFF_T " bytes\\n", dl);
! 54: }
! 55: }
! 56: }
! 57: .fi
! 58: .SH AVAILABILITY
! 59: Added in 7.55.0
! 60: .SH RETURN VALUE
! 61: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 62: .SH "SEE ALSO"
! 63: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
! 64: .BR CURLINFO_SIZE_DOWNLOAD "(3), "
! 65: .BR CURLINFO_SIZE_UPLOAD_T "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>