master-server/deps/curl/docs/libcurl/opts/CURLOPT_PROXYPORT.md
2024-05-15 15:20:32 -04:00

1.2 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_PROXYPORT 3 libcurl
CURLINFO_PRIMARY_PORT (3)
CURLOPT_PORT (3)
CURLOPT_PROXY (3)
CURLOPT_PROXYTYPE (3)
All

NAME

CURLOPT_PROXYPORT - port number the proxy listens on

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);

DESCRIPTION

We discourage use of this option.

Pass a long with this option to set the proxy port to connect to unless it is specified in the proxy string CURLOPT_PROXY(3) or uses 443 for https proxies and 1080 for all others as default.

While this accepts a 'long', the port number is 16 bit so it cannot be larger than 65535.

DEFAULT

0, not specified which makes it use the default port

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
    curl_easy_setopt(curl, CURLOPT_PROXY, "localhost");
    curl_easy_setopt(curl, CURLOPT_PROXYPORT, 8080L);
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Always

RETURN VALUE

Returns CURLE_OK