docs/libcurl/opts/CURLINFO_HTTP_CONNECTCODE.3

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