CURLINFO_RESPONSE_CODE.3 2.4 KB

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