CURLINFO_HEADER_SIZE.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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_HEADER_SIZE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_HEADER_SIZE \- get size of retrieved headers
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HEADER_SIZE, long *sizep);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a long to receive the total size of all the headers
  33. received. Measured in number of bytes.
  34. The total includes the size of any received headers suppressed by
  35. \fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP.
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. CURLcode res;
  43. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  44. res = curl_easy_perform(curl);
  45. if(res == CURLE_OK) {
  46. long size;
  47. res = curl_easy_getinfo(curl, CURLINFO_HEADER_SIZE, &size);
  48. if(!res)
  49. printf("Header size: %ld bytes\\n", size);
  50. }
  51. curl_easy_cleanup(curl);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Added in 7.4.1
  56. .SH RETURN VALUE
  57. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  58. .SH "SEE ALSO"
  59. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  60. .BR CURLINFO_REQUEST_SIZE "(3), "
  61. .BR CURLINFO_SIZE_DOWNLOAD "(3), "