curl / libcurl / API / curl_easy_getinfo / CURLINFO_PRIMARY_PORT

CURLINFO_PRIMARY_PORT explained

Name

CURLINFO_PRIMARY_PORT - last destination port number

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_PORT, long *portp);

Description

Pass a pointer to a long to receive the destination port of the most recent connection done with this curl handle.

This is the destination port of the actual TCP or UDP connection libcurl used. If a proxy was used for the most recent transfer, this is the port number of the proxy, if no proxy was used it is the port number of the most recently accessed URL.

If the connection was done using QUIC, the port number is a UDP port number.

If no connection was established or if the protocol does not use ports, -1 is returned.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    res = curl_easy_perform(curl);
    if(res == CURLE_OK) {
      long port;
      res = curl_easy_getinfo(curl, CURLINFO_PRIMARY_PORT, &port);
      if(!res)
        printf("Connected to remote port: %ld\n", port);
    }
    curl_easy_cleanup(curl);
  }
}

Availability

Added in curl 7.21.0

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

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