mirror of
https://github.com/curl/curl.git
synced 2025-02-11 14:50:40 +08:00
b935fd4a07
The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLINFO_PRIMARY_IP
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_LOCAL_IP (3)
|
|
- CURLINFO_LOCAL_PORT (3)
|
|
- CURLINFO_PRIMARY_PORT (3)
|
|
- curl_easy_getinfo (3)
|
|
- curl_easy_setopt (3)
|
|
Protocol:
|
|
- *
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLINFO_PRIMARY_IP - get IP address of last connection
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_IP, char **ip);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a pointer to a char pointer to receive the pointer to a null-terminated
|
|
string holding the IP address of the most recent connection done with this
|
|
**curl** handle. This string may be IPv6 when that is enabled. Note that you
|
|
get a pointer to a memory area that is reused at next request so you need to
|
|
copy the string if you want to keep the information.
|
|
|
|
The **ip** pointer is NULL or points to private memory. You MUST NOT free -
|
|
it gets freed when you call curl_easy_cleanup(3) on the corresponding
|
|
CURL handle.
|
|
|
|
# PROTOCOLS
|
|
|
|
All network based ones
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
char *ip;
|
|
CURLcode res;
|
|
CURL *curl = curl_easy_init();
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* Perform the transfer */
|
|
res = curl_easy_perform(curl);
|
|
/* Check for errors */
|
|
if((res == CURLE_OK) &&
|
|
!curl_easy_getinfo(curl, CURLINFO_PRIMARY_IP, &ip) && ip) {
|
|
printf("IP: %s\n", ip);
|
|
}
|
|
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.19.0
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|