FormsAuthenticationTicket Constructor (Int32, String, DateTime, DateTime, Boolean, String, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the FormsAuthenticationTicket class with cookie name, version, directory path, issue date, expiration date, persistence, and user-defined data.

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

new : 
        version:int *
        name:string *
        issueDate:DateTime *
        expiration:DateTime *
        isPersistent:bool *
        userData:string *
        cookiePath:string -> FormsAuthenticationTicket

Parameters

version
Type: System.Int32

The version number of the ticket.

name
Type: System.String

The user name associated with the ticket.

issueDate
Type: System.DateTime

The local date and time at which the ticket was issued.

expiration
Type: System.DateTime

The local date and time at which the ticket expires.

isPersistent
Type: System.Boolean

true if the ticket will be stored in a persistent cookie (saved across browser sessions); otherwise, false. If the ticket is stored in the URL, this value is ignored.

userData
Type: System.String

The user-specific data to be stored with the ticket.

cookiePath
Type: System.String

The path for the ticket when stored in a cookie.

System_CAPS_noteNote

The userData parameter cannot be null.

The following code example stores the result of the Encrypt method in a cookie using the FormsCookieName property and redirects the user to the URL returned from the GetRedirectUrl method.

System_CAPS_security Security Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: