FindUsersByName Method (String)
Collapse the table of content
Expand the table of content

Membership.FindUsersByName Method (String)

 

Gets a collection of membership users where the user name contains the specified user name to match.

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

public static MembershipUserCollection FindUsersByName(
	string usernameToMatch
)

Parameters

usernameToMatch
Type: System.String

The user name to search for.

Return Value

Type: System.Web.Security.MembershipUserCollection

A MembershipUserCollection that contains all users that match the usernameToMatch parameter.

Leading and trailing spaces are trimmed from the usernameToMatch parameter value.

Exception Condition
ArgumentException

usernameToMatch is an empty string.

ArgumentNullException

usernameToMatch is null.

FindUsersByName returns a list of membership users where the user name matches the supplied usernameToMatch for the configured applicationName.

The SqlMembershipProvider 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.

Leading and trailing spaces are trimmed from all parameter values.

The following code example uses the FindUsersByName method to retrieve membership user information from the membership database based on user input and displays the results in pages of data.

System_CAPS_security 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="C#" %>
<%@ 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">

public void GoButton_OnClick(object sender, EventArgs args)
{
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text);
  UserGrid.DataBind();
}

</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>

  Username to Search for: 
    <asp:TextBox id="UsernameTextBox" runat="server" />
    <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>

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft