RolePrincipal Constructor (IIdentity)

 

Instantiates a RolePrincipal object for the specified identity.

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

Public Sub New (
	identity As IIdentity
)

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.

Dim r As RolePrincipal

If Roles.CacheRolesInCookie Then
  Dim roleCookie As String = ""

  Dim cookie As HttpCookie = HttpContext.Current.Request.Cookies(Roles.CookieName)
  If Not cookie Is Nothing Then roleCookie = cookie.Value

  r = New RolePrincipal(User.Identity, roleCookie)
Else
  r = new RolePrincipal(User.Identity)
End If

.NET Framework
Available since 2.0
Return to top
Show: