CURLINFO_CONTENT_LENGTH_UPLOAD.3 2.3 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_CONTENT_LENGTH_UPLOAD 3 "1 Sep 2015" "libcurl" "libcurl"
  26. .SH NAME
  27. CURLINFO_CONTENT_LENGTH_UPLOAD \- get the specified size of the upload
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD,
  32. double *content_length);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a double to receive the specified size of the upload. Since
  36. 7.19.4, this returns -1 if the size is not known.
  37. \fICURLINFO_CONTENT_LENGTH_UPLOAD_T(3)\fP is a newer replacement that returns a
  38. more 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 upload */
  47. res = curl_easy_perform(curl);
  48. if(!res) {
  49. /* check the size */
  50. double cl;
  51. res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_UPLOAD, &cl);
  52. if(!res) {
  53. printf("Size: %.0f\\n", cl);
  54. }
  55. }
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.6.1. Deprecated since 7.55.0.
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  64. .BR CURLINFO_CONTENT_LENGTH_DOWNLOAD_T "(3), "