CURLINFO_PRIMARY_PORT.3 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLINFO_PRIMARY_PORT 3 "12 Sep 2015" libcurl libcurl
  26. .SH NAME
  27. CURLINFO_PRIMARY_PORT \- get the latest destination port number
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_PORT, long *portp);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a long to receive the destination port of the most recent
  35. connection done with this \fBcurl\fP handle.
  36. This is the destination port of the actual TCP or UDP connection libcurl used.
  37. If a proxy was used for the most recent transfer, this is the port number of
  38. the proxy, if no proxy was used it is the port number of the most recently
  39. accessed URL.
  40. .SH PROTOCOLS
  41. All
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. CURLcode res;
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  48. res = curl_easy_perform(curl);
  49. if(res == CURLE_OK) {
  50. long port;
  51. res = curl_easy_getinfo(curl, CURLINFO_PRIMARY_PORT, &port);
  52. if(!res)
  53. printf("Connected to remote port: %ld\\n", port);
  54. }
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.21.0
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "