This documentation is archived and is not being maintained.

RoleProvider::FindUsersInRole Method

Gets an array of user names in a role where the user name contains the specified user name to match.

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

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

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 where the user name matches usernameToMatch and the user is a member of the specified role.

The FindUsersInRole method is called by the Roles class and returns a list of users in a role where the user name contains a match of the supplied usernameToMatch for the configured applicationName. Wildcard support is included based on the data source. Users are returned in alphabetical order by user name.

We recommend that you throw a ProviderException if roleName does not exist in the data source.

The following code example shows a sample FindUsersInRole implementation.

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: