Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetAuthCookie Method (String, Boolean)
Collapse the table of content
Expand the table of content

FormsAuthentication.GetAuthCookie Method (String, Boolean)

Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.

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

'Declaration
Public Shared Function GetAuthCookie ( _
	userName As String, _
	createPersistentCookie As Boolean _
) As HttpCookie

Parameters

userName
Type: System.String
The name of the authenticated user.
createPersistentCookie
Type: System.Boolean
true to create a durable cookie (one that is saved across browser sessions); otherwise, false.

Return Value

Type: System.Web.HttpCookie
An HttpCookie that contains encrypted forms-authentication ticket information. The default value for the FormsCookiePath property is used.

The path of the cookie is determined by the FormsCookiePath property.

.NET Framework

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2015 Microsoft