Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
UserData Property

FormsAuthenticationTicket::UserData Property

Gets a user-specific string stored with the ticket.

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

public:
property String^ UserData {
	String^ get ();
}

Property Value

Type: System::String
A user-specific string stored with the ticket. The default is an empty string ("").

If the FormsAuthenticationTicket is created using a constructor that does not supply a userData parameter, the UserData property returns an empty string (""); otherwise, the version property returns the value supplied to the FormsAuthenticationTicket constructor.

You can use the UserData property to store additional user information with the FormsAuthenticationTicket that is not maintained by the FormsAuthenticationTicket property values.

NoteNote:

You should limit the amount of data stored in the UserData property. You must ensure that the size of the UserData property does not result in an invalid cookie or an excessively long URL.

The following code example displays the property values of the FormsAuthenticationTicket for the current logged-on user.

NoteNote:

If there is no logged-on user, the Identity property will be nullptr and you will receive a compiler exception when attempting to cast the Identity property as a FormsIdentity object.

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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

Community Additions

ADD
Show:
© 2015 Microsoft