docs/libcurl/opts/CURLINFO_PRIMARY_IP.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_PRIMARY_IP 3 "March 22, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_PRIMARY_IP \- get IP address of last connection
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIMARY_IP, char **ip);
  31 .SH DESCRIPTION
  32 Pass a pointer to a char pointer to receive the pointer to a zero-terminated
  33 string holding the IP address of the most recent connection done with this
  34 \fBcurl\fP handle. This string may be IPv6 when that is enabled. Note that you
  35 get a pointer to a memory area that will be re-used at next request so you
  36 need to copy the string if you want to keep the 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 network based ones
  43 .SH EXAMPLE
  44 .nf
  45 {
  46   char *ip;
  47
  48   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  49
  50   /* Perform the request, res will get the return code */
  51   res = curl_easy_perform(curl);
  52   /* Check for errors */
  53   if((res == CURLE_OK) &&
  54      !curl_easy_getinfo(curl, CURLINFO_PRIMARY_IP, &ip) && ip) {
  55     printf("IP: %s\\n", ip);
  56   }
  57
  58   /* always cleanup */
  59   curl_easy_cleanup(curl);
  60 }
  61 .fi
  62 .SH AVAILABILITY
  63 Added in 7.19.0
  64 .SH RETURN VALUE
  65 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  66 .SH "SEE ALSO"
  67 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  68 .BR CURLINFO_PRIMARY_PORT "(3), " CURLINFO_LOCAL_IP "(3), "