docs/libcurl/opts/CURLINFO_LOCAL_IP.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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 "12 Sep 2015" "libcurl 7.44.0" "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
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LOCAL_IP, char **ip);
  30 .SH DESCRIPTION
  31 Pass a pointer to a char pointer to receive the pointer to a zero-terminated
  32 string holding the IP address of the local end of most recent connection done
  33 with this \fBcurl\fP handle. This string may be IPv6 when that is
  34 enabled. Note that you get a pointer to a memory area that will be re-used at
  35 next request so you need to copy the string if you want to keep the
  36 information.
  37
  38 The \fBip\fP pointer will be NULL or pointing to private memory you MUST NOT
  39 free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  40 corresponding CURL handle.
  41 .SH PROTOCOLS
  42 All
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.21.0
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  49 .SH "SEE ALSO"
  50 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  51 .BR CURLINFO_PRIMARY_IP "(3), "