a7bf7261eafa927b34f32af549f7a74876b26f9d
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_REDIRECT_URL.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_REDIRECT_URL 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_REDIRECT_URL \- get the URL a redirect would go to
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_URL, char **urlp);
30 .SH DESCRIPTION
31 Pass a pointer to a char pointer to receive the URL a redirect \fIwould\fP
32 take you to if you would enable \fICURLOPT_FOLLOWLOCATION(3)\fP. This can come
33 very handy if you think using the built-in libcurl redirect logic isn't good
34 enough for you but you would still prefer to avoid implementing all the magic
35 of figuring out the new URL.
36 .SH PROTOCOLS
37 HTTP(S)
38 .SH EXAMPLE
39 TODO
40 .SH AVAILABILITY
41 Added in 7.18.2
42 .SH RETURN VALUE
43 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
44 .SH "SEE ALSO"
45 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "