This documentation is archived and is not being maintained.

Roles.GetUsersInRole Method

Gets a list of users in the specified role.

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

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

Parameters

roleName
Type: System.String

The role to get the list of users for.

Return Value

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

ExceptionCondition
System.ArgumentNullException

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

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: