aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/GNURLINFO_LOCAL_IP.3
diff options
context:
space:
mode:
authorng0 <ng0@infotropique.org>2017-08-22 18:16:20 +0000
committerng0 <ng0@infotropique.org>2017-08-22 18:16:20 +0000
commit25a03ee9c6133cfe1ce809a8ab1528ae7328fe35 (patch)
tree5ee3f3450604faedd1d4a9e53a3982c6ffcfe5fc /docs/libcurl/opts/GNURLINFO_LOCAL_IP.3
parent535a1e532345d3760d496b5b21052f23e8965f4c (diff)
downloadgnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.gz
gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.bz2
gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.zip
gnurl: Rename man3 files to avoid collisions.
This is necessary so that gnURL and cURL can co-exist on the same system. However renaming most of the files is not logical. Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'docs/libcurl/opts/GNURLINFO_LOCAL_IP.3')
-rw-r--r--docs/libcurl/opts/GNURLINFO_LOCAL_IP.368
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLINFO_LOCAL_IP.3 b/docs/libcurl/opts/GNURLINFO_LOCAL_IP.3
new file mode 100644
index 000000000..ee15faaf7
--- /dev/null
+++ b/docs/libcurl/opts/GNURLINFO_LOCAL_IP.3
@@ -0,0 +1,68 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" *
+.\" * This software is licensed as described in the file COPYING, which
+.\" * you should have received as part of this distribution. The terms
+.\" * are also available at https://curl.haxx.se/docs/copyright.html.
+.\" *
+.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
+.\" * copies of the Software, and permit persons to whom the Software is
+.\" * furnished to do so, under the terms of the COPYING file.
+.\" *
+.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+.\" * KIND, either express or implied.
+.\" *
+.\" **************************************************************************
+.\"
+.TH CURLINFO_LOCAL_IP 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
+.SH NAME
+CURLINFO_LOCAL_IP \- get local IP address of last connection
+.SH SYNOPSIS
+#include <gnurl/curl.h>
+
+CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LOCAL_IP, char **ip);
+.SH DESCRIPTION
+Pass a pointer to a char pointer to receive the pointer to a zero-terminated
+string holding the IP address of the local end of most recent connection done
+with this \fBcurl\fP handle. This string may be IPv6 when that is
+enabled. Note that you get a pointer to a memory area that will be re-used at
+next request so you need to copy the string if you want to keep the
+information.
+
+The \fBip\fP pointer will be NULL or pointing to private memory you MUST NOT
+free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
+corresponding CURL handle.
+.SH PROTOCOLS
+All
+.SH EXAMPLE
+.nf
+{
+ char *ip;
+
+ curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
+
+ /* Perform the request, res will get the return code */
+ res = curl_easy_perform(curl);
+ /* Check for errors */
+ if((res == CURLE_OK) &&
+ !curl_easy_getinfo(curl, CURLINFO_LOCAL_IP, &ip) && ip) {
+ printf("Local IP: %s\\n", ip);
+ }
+
+ /* always cleanup */
+ curl_easy_cleanup(curl);
+}
+.fi
+.SH AVAILABILITY
+Added in 7.21.0
+.SH RETURN VALUE
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+.SH "SEE ALSO"
+.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
+.BR CURLINFO_PRIMARY_IP "(3), "