.NET Framework Class Library
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.
Assembly: System.Web (in System.Web.dll)
Syntax
Visual Basic
Public Shared Function GetAuthCookie ( _ userName As String, _ createPersistentCookie As Boolean, _ strCookiePath As String _ ) As HttpCookie
C#
public static HttpCookie GetAuthCookie( string userName, bool createPersistentCookie, string strCookiePath )
Visual C++
public: static HttpCookie^ GetAuthCookie( String^ userName, bool createPersistentCookie, String^ strCookiePath )
F#
static member GetAuthCookie : userName:string * createPersistentCookie:bool * strCookiePath:string -> 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.
- strCookiePath
- Type: System.String
The Path of the authentication cookie.
Return Value
Type: System.Web.HttpCookieAn HttpCookie that contains encrypted forms-authentication ticket information.
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0Platforms
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.
See Also