System.Web.Security.FormsAuthentication.GetRedirectUrl Method

Returns the redirect URL for the original request that caused the redirect to the login page.

Syntax

public static string GetRedirectUrl (string userName, bool createPersistentCookie)

Parameters

userName
The name of the authenticated user.
createPersistentCookie
This parameter is ignored.

Returns

A string that contains the redirect URL.

Remarks

You can use this method when you want to perform the redirect in your application code instead of using the FormsAuthentication.RedirectFromLoginPage(string, bool) method.

The FormsAuthentication.GetRedirectUrl(string, bool) method returns the URL specified in the query string using the ReturnURL variable name. For example, in the URL http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx, the FormsAuthentication.GetRedirectUrl(string, bool) method returns the return URL caller.aspx. If the ReturnURL variable does not exist, the FormsAuthentication.GetRedirectUrl(string, bool) method returns the URL in the FormsAuthentication.DefaultUrl property.

ASP.NET automatically adds the return URL when the browser is redirected to the login page.

By default, the ReturnUrl variable must refer to a page within the current application. If ReturnUrl refers to a page in a different application or on a different server, the FormsAuthentication.GetRedirectUrl(string, bool) methods returns the URL in the FormsAuthentication.DefaultUrl property. If you want to allow the return URL to refer to a page outside the current application, you must set the FormsAuthentication.EnableCrossAppRedirects property to true using the enableCrossAppRedirects attribute of the forms configuration element.

Note:

Setting the FormsAuthentication.EnableCrossAppRedirects property to true to allow cross-application redirects is a potential security threat. For more information, see the FormsAuthentication.EnableCrossAppRedirects property.

Requirements

Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0