1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_PRIMARY_IP
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_LOCAL_IP (3)
9  - CURLINFO_LOCAL_PORT (3)
10  - CURLINFO_PRIMARY_PORT (3)
11  - curl_easy_getinfo (3)
12  - curl_easy_setopt (3)
13Protocol:
14  - All
15Added-in: 7.19.0
16---
17
18# NAME
19
20CURLINFO_PRIMARY_IP - get IP address of last connection
21
22# SYNOPSIS
23
24~~~c
25#include <curl/curl.h>
26
27CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_IP, char **ip);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a char pointer to receive the pointer to a null-terminated
33string holding the IP address of the most recent connection done with this
34**curl** handle. This string may be IPv6 when that is enabled. Note that you
35get a pointer to a memory area that is reused at next request so you need to
36copy the string if you want to keep the information.
37
38The **ip** pointer is NULL or points to private memory. You MUST NOT free -
39it gets freed when you call curl_easy_cleanup(3) on the corresponding
40CURL handle.
41
42# %PROTOCOLS%
43
44# EXAMPLE
45
46~~~c
47int main(void)
48{
49  char *ip;
50  CURLcode res;
51  CURL *curl = curl_easy_init();
52
53  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
54
55  /* Perform the transfer */
56  res = curl_easy_perform(curl);
57  /* Check for errors */
58  if((res == CURLE_OK) &&
59     !curl_easy_getinfo(curl, CURLINFO_PRIMARY_IP, &ip) && ip) {
60    printf("IP: %s\n", ip);
61  }
62
63  /* always cleanup */
64  curl_easy_cleanup(curl);
65}
66~~~
67
68# %AVAILABILITY%
69
70# RETURN VALUE
71
72Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
73