This documentation is archived and is not being maintained.

RolePrincipal Constructor (String, IIdentity)

Instantiates a RolePrincipal object for the specified identity using the specified providerName.

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

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

Parameters

providerName
Type: System.String
The name of the role provider for the user.
identity
Type: System.Security.Principal.IIdentity
The user identity to create the RolePrincipal for.

ExceptionCondition
System.ArgumentNullException

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

System.ArgumentException

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

-or-

providerName refers to a role provider that does not exist in the configuration for the application.

This overload of the RolePrincipal constructor creates a new RolePrincipal object and initializes its property values. The ProviderName property is set to the value specified in the providerName parameter.

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

.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: