docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 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_EFFECTIVE_URL 3 "May 04, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_EFFECTIVE_URL \- get the last used URL
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_EFFECTIVE_URL, char **urlp);
  31 .SH DESCRIPTION
  32 Pass in a pointer to a char pointer and get the last used effective URL.
  33
  34 In cases when you've asked libcurl to follow redirects, it may very well not
  35 be the same value you set with \fICURLOPT_URL(3)\fP.
  36
  37 The \fBurlp\fP pointer will be NULL or pointing to private memory you MUST NOT
  38 free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  39 corresponding CURL handle.
  40 .SH PROTOCOLS
  41 HTTP(S)
  42 .SH EXAMPLE
  43 .nf
  44 CURL *curl = curl_easy_init();
  45 if(curl) {
  46   CURLcode res;
  47   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  48   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  49   res = curl_easy_perform(curl);
  50   if(res == CURLE_OK) {
  51     char *url = NULL;
  52     curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &url);
  53     if(url)
  54       printf("Redirect to: %s\\n", url);
  55   }
  56   curl_easy_cleanup(curl);
  57 }
  58 .fi
  59 .SH AVAILABILITY
  60 Added in 7.4
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  63 .SH "SEE ALSO"
  64 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "