www.LinuxHowtos.org

CURLINFO_USED_PROXY

Section: C Library Functions (3)
Updated: 202-0-19
Index Return to Main Contents

NAME

CURLINFO_USED_PROXY - whether the transfer used a proxy

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_USED_PROXY,
                           long *authp);

DESCRIPTION

Pass a pointer to a long. It gets set to zero set if no proxy was used in the previous transfer or a non-zero value if a proxy was used.

PROTOCOLS

This functionality affects all supported protocols

EXAMPLE

int main(int argc, char *argv[])
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
    curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");
    curl_easy_setopt(curl, CURLOPT_NOPROXY, "example.com");

    result = curl_easy_perform(curl);

    if(result == CURLE_OK) {
      /* extract the available proxy authentication types */
      long used;
      result = curl_easy_getinfo(curl, CURLINFO_USED_PROXY, &used);
      if(result == CURLE_OK) {
        printf("The proxy was %susedn", used ? "" : "NOT ");
      }
    }
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in curl 8.7.0

RETURN VALUE

curl_easy_getinfo(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).