Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_PRIMARY_PORT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLINFO_PRIMARY_PORT 3 "May 06, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_PRIMARY_PORT \- get the latest destination port number
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_PORT, long *portp);
31 .SH DESCRIPTION
32 Pass a pointer to a long to receive the destination port of the most recent
33 connection done with this \fBcurl\fP handle.
34 .SH PROTOCOLS
35 All
36 .SH EXAMPLE
37 .nf
38 CURL *curl = curl_easy_init();
39 if(curl) {
40   CURLcode res;
41   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
42   res = curl_easy_perform(curl);
43   if(res == CURLE_OK) {
44     long port;
45     res = curl_easy_getinfo(curl, CURLINFO_PRIMARY_PORT, &port);
46     if(!res)
47       printf("Connected to remote port: %ld\\n", port);
48   }
49   curl_easy_cleanup(curl);
50 }
51 .fi
52 .SH AVAILABILITY
53 Added in 7.21.0
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
56 .SH "SEE ALSO"
57 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "