Roles::GetUsersInRole Method (String^)

 

Gets a list of users in the specified role.

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

public:
static array<String^>^ GetUsersInRole(
	String^ roleName
)

Parameters

roleName
Type: System::String^

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.

Exception Condition
System::ArgumentNullException

roleName is null.

System::ArgumentException

roleName is an empty string or contains a comma (,).

System.Configuration.Provider::ProviderException

Role management is not enabled.

The GetUsersInRole method calls the GetUsersInRole method of the default role provider to retrieve the user names associated with a role from the data source. Only the roles for the application that is specified in the ApplicationName property are retrieved.

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

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

.NET Framework
Available since 2.0
Return to top
Show: