CURLINFO_LOCAL_IP.3 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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_LOCAL_IP 3 "May 05, 2017" "libcurl 7.61.1" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_LOCAL_IP \- get local IP address of last connection
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LOCAL_IP, char **ip);
  29. .SH DESCRIPTION
  30. Pass a pointer to a char pointer to receive the pointer to a zero-terminated
  31. string holding the IP address of the local end of most recent connection done
  32. with this \fBcurl\fP handle. This string may be IPv6 when that is
  33. enabled. Note that you get a pointer to a memory area that will be re-used at
  34. next request so you need to copy the string if you want to keep the
  35. information.
  36. The \fBip\fP pointer will be NULL or pointing to private memory you MUST NOT
  37. free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  38. corresponding CURL handle.
  39. .SH PROTOCOLS
  40. All
  41. .SH EXAMPLE
  42. .nf
  43. {
  44. char *ip;
  45. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  46. /* Perform the request, res will get the return code */
  47. res = curl_easy_perform(curl);
  48. /* Check for errors */
  49. if((res == CURLE_OK) &&
  50. !curl_easy_getinfo(curl, CURLINFO_LOCAL_IP, &ip) && ip) {
  51. printf("Local IP: %s\\n", ip);
  52. }
  53. /* always cleanup */
  54. curl_easy_cleanup(curl);
  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_IP "(3), "