CURLINFO_SIZE_UPLOAD_T.3 2.1 KB

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