CURLINFO_LOCAL_PORT.3 2.2 KB

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