FindUsersByName Method (String, Int32, Int32, Int32)

Membership.FindUsersByName Method (String, Int32, Int32, Int32)


Gets a collection of membership users, in a page of data, 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,
	int pageIndex,
	int pageSize,
	out int totalRecords


Type: System.String

The user name to search for.

Type: System.Int32

The index of the page of results to return. pageIndex is zero-based.

Type: System.Int32

The size of the page of results to return.

Type: System.Int32

The total number of matched users.

Return Value

Type: System.Web.Security.MembershipUserCollection

A MembershipUserCollection that contains a page of pageSizeMembershipUser objects beginning at the page specified by pageIndex.

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

Exception Condition

usernameToMatch is an empty string.


pageIndex is less than zero.


pageSize is less than 1.


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.

The results returned by FindUsersByName are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where 0 identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users that matched the usernameToMatch value. For example, if 13 users were found where usernameToMatch matched part of or the entire user name, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users returned. totalRecords would be set to 13.

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"
<script runat="server">

int pageSize = 5;
int totalUsers;
int totalPages;
int currentPage = 1;

private void GetUsers()
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text, 
                          currentPage - 1, pageSize, out totalUsers);
  totalPages = ((totalUsers - 1) / pageSize) + 1;

  // Ensure that we do not navigate past the last page of users.

  if (currentPage > totalPages)
    currentPage = totalPages;

  CurrentPageLabel.Text = currentPage.ToString();
  TotalPagesLabel.Text = totalPages.ToString();

  if (currentPage == totalPages)
    NextButton.Visible = false;
    NextButton.Visible = true;

  if (currentPage == 1)
    PreviousButton.Visible = false;
    PreviousButton.Visible = true;

  if (totalUsers <= 0)
    NavigationPanel.Visible = false;
    NavigationPanel.Visible = true;

public void NextButton_OnClick(object sender, EventArgs args)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text);

public void PreviousButton_OnClick(object sender, EventArgs args)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text);

public void GoButton_OnClick(object sender, EventArgs args)
  currentPage = 1;

<html xmlns="" >
<title>Sample: Find Users</title>

<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:Panel id="NavigationPanel" Visible="false" runat="server">
    <table border="0" cellpadding="3" cellspacing="3">
        <td style="width:100">Page <asp:Label id="CurrentPageLabel" runat="server" />
            of <asp:Label id="TotalPagesLabel" runat="server" /></td>
        <td style="width:60"><asp:LinkButton id="PreviousButton" Text="< Prev"
                            OnClick="PreviousButton_OnClick" runat="server" /></td>
        <td style="width:60"><asp:LinkButton id="NextButton" Text="Next >"
                            OnClick="NextButton_OnClick" runat="server" /></td>

  <asp:DataGrid id="UserGrid" runat="server"
                CellPadding="2" CellSpacing="1"
    <HeaderStyle BackColor="darkblue" ForeColor="white" />



.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft