CURLINFO_SIZE_UPLOAD_T.3 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLINFO_SIZE_UPLOAD_T 3 "25 May 2017" libcurl libcurl
  26. .SH NAME
  27. CURLINFO_SIZE_UPLOAD_T \- get the number of uploaded bytes
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_UPLOAD_T,
  32. curl_off_t *uploadp);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
  36. were uploaded.
  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, "https://example.com");
  44. /* Perform the request */
  45. res = curl_easy_perform(curl);
  46. if(!res) {
  47. curl_off_t ul;
  48. res = curl_easy_getinfo(curl, CURLINFO_SIZE_UPLOAD_T, &ul);
  49. if(!res) {
  50. printf("Uploaded %" CURL_FORMAT_CURL_OFF_T " bytes\\n", ul);
  51. }
  52. }
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.55.0
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  59. .SH "SEE ALSO"
  60. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  61. .BR CURLINFO_SIZE_DOWNLOAD_T "(3), " CURLINFO_SIZE_UPLOAD "(3), "