This documentation is archived and is not being maintained.

RolePrincipal Constructor (IIdentity, String)

Instantiates a RolePrincipal object for the specified identity with role information from the specified encryptedTicket.

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

new : 
        identity:IIdentity * 
        encryptedTicket:string -> RolePrincipal

Parameters

identity
Type: System.Security.Principal.IIdentity
The user identity to create the RolePrincipal for.
encryptedTicket
Type: System.String
A string that contains encrypted role information.

ExceptionCondition
System.ArgumentNullException

identity is a null reference (Nothing in Visual Basic).

-or-

encryptedTicket is a null reference (Nothing in Visual Basic).

This overload of the RolePrincipal constructor creates a new RolePrincipal object and initializes its property values. Role information for the current user is read from the supplied encryptedTicket and cached with the RolePrincipal object. The ProviderName property is set to the Name of the default role provider.

For information on enabling role management, see the Roles class.

The following code example creates a new RolePrincipal object. If CacheRolesInCookie is true, the example creates the RolePrincipal with cookie information from the cookie identified by the CookieName property.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.
Show: