Export (0) Print
Expand All

FormsAuthentication::SetAuthCookie Method (String, Boolean)

Creates an authentication ticket for the supplied user name and adds it to the cookies collection of the response, or to the URL if you are using cookieless authentication.

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)

public:
static void SetAuthCookie(
	String^ userName, 
	bool createPersistentCookie
)

Parameters

userName
Type: System::String

The name of an authenticated user. This does not have to map to a Windows account.

createPersistentCookie
Type: System::Boolean

true to create a persistent cookie (one that is saved across browser sessions); otherwise, false.

ExceptionCondition
HttpException

RequireSSL is true and IsSecureConnection is false.

The SetAuthCookie method adds a forms-authentication ticket to either the cookies collection, or to the URL if CookiesSupported is false. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the SetAuthCookie method when you want to authenticate a user but still retain control of the navigation with redirects.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft