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.

Exception Condition
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
Available since 1.1
Return to top
Show: