This documentation is archived and is not being maintained.

RoleProviderCollection.Item Property

Gets the role provider in the collection referenced by the specified provider name.

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

'Declaration
Public ReadOnly Property Item ( _
	name As String _
) As RoleProvider

Parameters

name
Type: System.String
The name of the role provider.

Property Value

Type: System.Web.Security.RoleProvider
An object that inherits the RoleProvider abstract class.

The role providers for an application are exposed as a read-only RoleProviderCollection by the Providers property of the Roles class. You can access a specific role provider in the collection by name and cast it as the specific provider type, such as SqlRoleProvider. This enables you to manage role information from multiple data stores in a single application as well as access custom members of a role provider that are not part of the RoleProvider abstract class.

The following code example accesses a SqlRoleProvider configured for an application from the Providers property of the Roles class by name.


Dim p As SqlRoleProvider = CType(Roles.Providers("SqlProvider"), SqlRoleProvider)
DescriptionLabel.Text = p.Description


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