CURLINFO_RESPONSE_CODE.3 2.4 KB

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