Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SIZE_UPLOAD_T.3, revision 1.1.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_UPLOAD_T 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_SIZE_UPLOAD_T \- get the number of uploaded bytes
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_UPLOAD_T, curl_off_t *uploadp);
                     31: .SH DESCRIPTION
                     32: Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
                     33: were uploaded.
                     34: .SH PROTOCOLS
                     35: All
                     36: .SH EXAMPLE
                     37: .nf
                     38: CURL *curl = curl_easy_init();
                     39: if(curl) {
                     40:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     41: 
                     42:   /* Perform the request */
                     43:   res = curl_easy_perform(curl);
                     44: 
                     45:   if(!res) {
                     46:     curl_off_t ul;
                     47:     res = curl_easy_getinfo(curl, CURLINFO_SIZE_UPLOAD_T, &ul);
                     48:     if(!res) {
                     49:       printf("Uploaded %" CURL_FORMAT_CURL_OFF_T " bytes\\n", ul);
                     50:     }
                     51:   }
                     52: }
                     53: .fi
                     54: .SH AVAILABILITY
                     55: Added in 7.55.0
                     56: .SH RETURN VALUE
                     57: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     58: .SH "SEE ALSO"
                     59: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
                     60: .BR CURLINFO_SIZE_DOWNLOAD_T "(3), " CURLINFO_SIZE_UPLOAD "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>