This documentation is archived and is not being maintained.

Roles::FindUsersInRole Method

Gets a list of users in a specified role where the user name contains the specified user name to match.

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

public:
static array<String^>^ FindUsersInRole(
	String^ roleName, 
	String^ usernameToMatch
)

Parameters

roleName
Type: System::String

The role to search in.

usernameToMatch
Type: System::String

The user name to search for.

Return Value

Type: array<System::String>
A string array containing the names of all the users whose user name matches usernameToMatch and who are members of the specified role.

ExceptionCondition
System::ArgumentNullException

roleName is nullptr (Nothing in Visual Basic).

-or-

usernameToMatch is nullptr.

System::ArgumentException

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

-or-

usernameToMatch is an empty string.

System.Configuration.Provider::ProviderException

Role management is not enabled.

FindUsersInRole returns a list of users in a role where the user name contains a match of the supplied usernameToMatch for the configured applicationName. For example, if the usernameToMatch parameter is set to "user," then the users "user1," "user2," "user3," and so on are returned. Users are returned in alphabetical order by user name.

The SqlRoleProvider performs its search using a LIKE clause against the usernameToMatch parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the usernameToMatch parameter value.

The following code example uses the FindUsersInRole method to display role membership based on user input. For an example of a Web.config file that enables role management, see Roles.

Security noteSecurity Note:

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

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: