CURLINFO_HTTP_CONNECTCODE.3 2.3 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_HTTP_CONNECTCODE 3 "28 Aug 2015" libcurl libcurl
  26. .SH NAME
  27. CURLINFO_HTTP_CONNECTCODE \- get the CONNECT response code
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTP_CONNECTCODE, long *p);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a long to receive the last received HTTP proxy response code
  35. to a CONNECT request. The returned value will be zero if no such response code
  36. was available.
  37. .SH PROTOCOLS
  38. HTTP
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. if(curl) {
  43. CURLcode res;
  44. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  45. /* typically CONNECT is used to do HTTPS over HTTP proxies */
  46. curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1");
  47. res = curl_easy_perform(curl);
  48. if(res == CURLE_OK) {
  49. long code;
  50. res = curl_easy_getinfo(curl, CURLINFO_HTTP_CONNECTCODE, &code);
  51. if(!res && code)
  52. printf("The CONNECT response code: %03ld\\n", code);
  53. }
  54. curl_easy_cleanup(curl);
  55. }
  56. .fi
  57. .SH AVAILABILITY
  58. Added in 7.10.7
  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 CURLINFO_RESPONSE_CODE "(3), "
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "