CURLINFO_SIZE_UPLOAD.3 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_SIZE_UPLOAD \- 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,
  32. double *uploadp);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a double to receive the total amount of bytes that were
  36. uploaded.
  37. \fICURLINFO_SIZE_UPLOAD_T(3)\fP is a newer replacement that returns a more
  38. sensible variable type.
  39. .SH PROTOCOLS
  40. All
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  46. /* Perform the request */
  47. res = curl_easy_perform(curl);
  48. if(!res) {
  49. double ul;
  50. res = curl_easy_getinfo(curl, CURLINFO_SIZE_UPLOAD, &ul);
  51. if(!res) {
  52. printf("Uploaded %.0f bytes\\n", ul);
  53. }
  54. }
  55. }
  56. .fi
  57. .SH AVAILABILITY
  58. Added in 7.4.1. Deprecated since 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_SIZE_DOWNLOAD_T "(3), " CURLINFO_SIZE_UPLOAD_T "(3), "