2
0

CURLINFO_RESPONSE_CODE.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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_RESPONSE_CODE 3 "28 Aug 2015" libcurl libcurl
  26. .SH NAME
  27. CURLINFO_RESPONSE_CODE \- get the last response code
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RESPONSE_CODE, long *codep);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a long to receive the last received HTTP, FTP, SMTP or
  35. LDAP (OpenLDAP only) response code. This option was previously known as
  36. CURLINFO_HTTP_CODE in libcurl 7.10.7 and earlier.
  37. The stored value will be zero if no server response code has been received.
  38. Note that a proxy's CONNECT response should
  39. be read with \fICURLINFO_HTTP_CONNECTCODE(3)\fP and not this.
  40. .SH PROTOCOLS
  41. HTTP, FTP, SMTP and LDAP
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. CURLcode res;
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  48. res = curl_easy_perform(curl);
  49. if(res == CURLE_OK) {
  50. long response_code;
  51. curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);
  52. }
  53. curl_easy_cleanup(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.10.8. CURLINFO_HTTP_CODE was added in 7.4.1.
  58. Support for SMTP responses added in 7.25.0, for OpenLDAP in 7.81.0.
  59. .SH RETURN VALUE
  60. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  61. .SH "SEE ALSO"
  62. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  63. .BR CURLINFO_HTTP_CONNECTCODE "(3), "