CURLINFO_HEADER_SIZE.3 2.2 KB

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