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)

public RolePrincipal(
	IIdentity identity,
	string encryptedTicket
)

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.

Exception Condition
System.ArgumentNullException

identity is null.

-or-

encryptedTicket is null.

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.

RolePrincipal r;

if (Roles.CacheRolesInCookie)
{
  string roleCookie = "";

  HttpCookie cookie = HttpContext.Current.Request.Cookies[Roles.CookieName];
  if (cookie != null) { roleCookie = cookie.Value; }

  r = new RolePrincipal(User.Identity, roleCookie);
}
else
{
  r = new RolePrincipal(User.Identity);
}

.NET Framework
Available since 2.0
Return to top
Show: