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)

'Declaration
Public Shared Sub SetAuthCookie ( _
	userName As String, _
	createPersistentCookie As Boolean _
)
'Usage
Dim userName As String 
Dim createPersistentCookie As Boolean 

FormsAuthentication.SetAuthCookie(userName, 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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft