Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PORT (3)

Name

CURLOPT_PORT - remote port number to connect to

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PORT, long number);

Description

CURLOPT_PORT(3)            curl_easy_setopt options            CURLOPT_PORT(3)



NAME
       CURLOPT_PORT - remote port number to connect to

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PORT, long number);

DESCRIPTION
       This  option  sets  number  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 'long', a port number is usually a  16  bit
       number  and  therefore using a port number over 65535 will cause a run-
       time error.

DEFAULT
       By default this is 0 which makes it not used.

PROTOCOLS
       Used for all protocols that speak to a port number.

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
         curl_easy_setopt(curl, CURLOPT_PORT, 8080L);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_STDERR(3), CURLOPT_DEBUGFUNCTION(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                  March 29, 2022                 CURLOPT_PORT(3)