This documentation is archived and is not being maintained.

FormsAuthentication.GetAuthCookie Method (String, Boolean, String)

Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response.

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

static member GetAuthCookie : 
        userName:string * 
        createPersistentCookie:bool * 
        strCookiePath:string -> HttpCookie 


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

Return Value

Type: System.Web.HttpCookie
An HttpCookie that contains encrypted forms-authentication ticket information.

.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.