Roles.FindUsersInRole Method
Gets a list of users in a specified role where the user name contains the specified user name to match.
Assembly: System.Web (in System.Web.dll)
'Declaration Public Shared Function FindUsersInRole ( _ roleName As String, _ usernameToMatch As String _ ) As String()
Parameters
- roleName
- Type: System.String
The role to search in.
- usernameToMatch
- Type: System.String
The user name to search for.
Return Value
Type: 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.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | roleName is Nothing (Nothing in Visual Basic). -or- usernameToMatch is Nothing. |
| 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 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. |
<%@ Page Language="VB" %> <%@ Import Namespace="System.Web.Security" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Dim users() As String Public Sub Page_Load() If Not IsPostBack Then RolesListBox.DataSource = Roles.GetAllRoles() RolesListBox.DataBind() End If End SUb Public Sub GoButton_OnClick(sender As Object, args As EventArgs) Msg.Text = "" users = Nothing If RolesListBox.SelectedItem Is Nothing Then Msg.Text = "Please select a role." Return End If users = Roles.FindUsersInRole(RolesListBox.SelectedItem.Text, UsernameTextBox.Text) If users.Length < 1 Then Msg.Text = "No matching users found in selected role." End If UserGrid.DataSource = users UserGrid.DataBind() End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head> <title>Sample: Find Users</title> </head> <body> <form id="form1" runat="server"> <h3>User List</h3> <asp:Label id="Msg" runat="Server" ForeColor="red" /> <table border="0" cellpadding="3" cellspacing="3"> <tr> <td valign="top">Role:</td> <td valign="top"><asp:ListBox id="RolesListBox" runat="Server" /></td> </tr> <tr> <td valign="top">Username to Search for:</td> <td valign="top"><asp:TextBox id="UsernameTextBox" runat="server" /></td> </tr> </table> <asp:Button id="GoButton" Text=" Go " OnClick="GoButton_OnClick" runat="server" /><br /> <asp:DataGrid id="UserGrid" runat="server" CellPadding="2" CellSpacing="1" Gridlines="Both"> <HeaderStyle BackColor="darkblue" ForeColor="white" /> </asp:DataGrid> </form> </body> </html>
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.
Security Note