RolePrincipal Constructor (IIdentity)

 
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.

Instantiates a RolePrincipal object for the specified identity.

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

public RolePrincipal(
	IIdentity identity
)

Parameters

identity
Type: System.Security.Principal.IIdentity

The user identity to create the RolePrincipal for.

Exception Condition
System.ArgumentNullException

identity is null.

This overload of the RolePrincipal constructor creates a new RolePrincipal object and initializes its property values. Cached role information is not read from the cookie identified by the CookieName property. 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: