This documentation is archived and is not being maintained.

SqlRoleProvider::GetUsersInRole Method

Gets a list of users in the specified role.

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

public:
virtual array<String^>^ GetUsersInRole(
	String^ roleName
) override

Parameters

roleName
Type: System::String
The name of the role to get the list of users for.

Return Value

Type: array<System::String>
A string array containing the names of all the users who are members of the specified role.

ExceptionCondition
System::ArgumentNullException

roleName is nullptr.

System::ArgumentException

roleName is an empty string or contains a comma.

-or-

roleName is longer than 256 characters.

System.Configuration.Provider::ProviderException

rolename was not found in the database.

-or-

An unknown error occurred while communicating with the database.

The GetUsersInRole method is called by the Roles class to retrieve the list of users associated with the specified role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config).

The following code example uses the GetUsersInRole method to get a list of the users in a particular role and bind the results to a System.Web.UI.WebControls::GridView control. For an example of a Web.config file that enables role management, see SqlRoleProvider.

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

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