repo/core/curl/files/CURLOPT_PORT.3

.\" generated by cd2nroff 0.1 from CURLOPT_PORT.md
.TH CURLOPT_PORT 3 "2024-08-02" libcurl
.SH NAME
CURLOPT_PORT \- remote port number to connect to
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PORT, long number);
.fi
.SH DESCRIPTION
We discourage using this option since its scope is not obvious and hard to
predict. Set the preferred port number in the URL instead.

This option sets \fInumber\fP to be the remote port number to connect to,
instead of the one specified in the URL or the default port for the used
protocol.

Usually, you just let the URL decide which port to use but this allows the
application to override that.

While this option accepts a \(aqlong\(aq, a port number is an unsigned 16 bit number
and therefore using a port number lower than zero or over 65535 causes a
\fBCURLE_BAD_FUNCTION_ARGUMENT\fP error.
.SH DEFAULT
0 which makes it not used. This also makes port number zero impossible to set
with this API.
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
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_PORT, 8080L);
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}
.fi
.SH AVAILABILITY
Added in curl 7.1
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLINFO_PRIMARY_PORT (3),
.BR CURLOPT_STDERR (3),
.BR CURLOPT_URL (3)