Roles.Provider Property

 
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.

Gets the default role provider for the application.

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

static member Provider : RoleProvider with get

Property Value

Type: System.Web.Security.RoleProvider

The default role provider for the application, which is exposed as a class that inherits the RoleProvider abstract class.

Exception Condition
System.Configuration.Provider.ProviderException

Role management is not enabled.

The Provider property enables you to directly reference the default role provider for an application. This is commonly used to access custom members of the role provider that are not part of the RoleProvider abstract class.

For example, the WindowsTokenRoleProvider class includes an overload of the IsUserInRole method that enables you to determine whether a user is in a common Windows role by using a WindowsBuiltInRole enumeration value. A reference to the WindowsTokenRoleProvider class for an application can be obtained by using the Provider property and can be cast as a WindowsTokenRoleProvider in order to refer to the IsUserInRole overload.

If multiple role providers are configured for an application, you can access different role providers using the Providers collection.

The following code example casts the default role provider as a WindowsTokenRoleProvider and checks whether the currently logged-on user is in the Administrators role before allowing the user to view roles settings for the application. For an example of a Web.config file that enables role management, see WindowsTokenRoleProvider.

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

.NET Framework
Available since 2.0
Return to top
Show: