docs/libcurl/opts/CURLINFO_REDIRECT_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_REDIRECT_URL 3 "June 24, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_REDIRECT_URL \- get the URL a redirect would go to
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_URL, char **urlp);
  31 .SH DESCRIPTION
  32 Pass a pointer to a char pointer to receive the URL a redirect \fIwould\fP
  33 take you to if you would enable \fICURLOPT_FOLLOWLOCATION(3)\fP. This can come
  34 very handy if you think using the built-in libcurl redirect logic isn't good
  35 enough for you but you would still prefer to avoid implementing all the magic
  36 of figuring out the new URL.
  37
  38 This URL is also set if the \fICURLOPT_MAXREDIRS(3)\fP limit prevented a
  39 redirect to happen (since 7.54.1).
  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   res = curl_easy_perform(curl);
  49   if(res == CURLE_OK) {
  50     char *url = NULL;
  51     curl_easy_getinfo(curl, CURLINFO_REDIRECT_URL, &url);
  52     if(url)
  53       printf("Redirect to: %s\\n", url);
  54   }
  55   curl_easy_cleanup(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Added in 7.18.2
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "