CURLINFO_CONTENT_LENGTH_UPLOAD.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLINFO_CONTENT_LENGTH_UPLOAD 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_CONTENT_LENGTH_UPLOAD \- get the specified size of the upload
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD,
  30. double *content_length);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a double to receive the specified size of the upload. Since
  34. 7.19.4, this returns -1 if the size is not known.
  35. \fICURLINFO_CONTENT_LENGTH_UPLOAD_T(3)\fP is a newer replacement that returns a
  36. more sensible variable type.
  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 upload */
  45. res = curl_easy_perform(curl);
  46. if(!res) {
  47. /* check the size */
  48. double cl;
  49. res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_UPLOAD, &cl);
  50. if(!res) {
  51. printf("Size: %.0f\\n", cl);
  52. }
  53. }
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.6.1
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60. .SH "SEE ALSO"
  61. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  62. .BR CURLINFO_CONTENT_LENGTH_DOWNLOAD_T "(3), "