FormsAuthentication.GetAuthCookie Method

Definition

Namespace:

System.Web.Security

Assembly:

System.Web.dll

Creates an authentication cookie for a given user name.

Overloads

GetAuthCookie(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.
GetAuthCookie(String, Boolean, String)	Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response.

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

public:
 static System::Web::HttpCookie ^ GetAuthCookie(System::String ^ userName, bool createPersistentCookie);

public static System.Web.HttpCookie GetAuthCookie (string userName, bool createPersistentCookie);

static member GetAuthCookie : string * bool -> System.Web.HttpCookie

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

Parameters

userName

String

The name of the authenticated user.

createPersistentCookie

Boolean

true to create a durable cookie (one that is saved across browser sessions); otherwise, false.

Returns

HttpCookie

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

Remarks

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

See also

• ASP.NET Web Application Security

GetAuthCookie(String, Boolean, String)

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

public:
 static System::Web::HttpCookie ^ GetAuthCookie(System::String ^ userName, bool createPersistentCookie, System::String ^ strCookiePath);

public static System.Web.HttpCookie GetAuthCookie (string userName, bool createPersistentCookie, string strCookiePath);

static member GetAuthCookie : string * bool * string -> System.Web.HttpCookie

Public Shared Function GetAuthCookie (userName As String, createPersistentCookie As Boolean, strCookiePath As String) As HttpCookie

Parameters

userName

String

The name of the authenticated user.

createPersistentCookie

Boolean

true to create a durable cookie (one that is saved across browser sessions); otherwise, false.

strCookiePath

String

The Path of the authentication cookie.

Returns

HttpCookie

An HttpCookie that contains encrypted forms-authentication ticket information.

See also

• ASP.NET Web Application Security