Membership.FindUsersByName 方法

参考

定义

命名空间:: System.Web.Security

程序集:: System.Web.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

获取一个成员资格用户的集合，其中的用户名包含要匹配的指定用户名。

重载

FindUsersByName(String)	获取一个成员资格用户的集合，其中的用户名包含要匹配的指定用户名。
FindUsersByName(String, Int32, Int32, Int32)	获取一个成员资格用户的集合，并显示在一个数据页中，这些用户的用户名包含要匹配的指定用户名。

FindUsersByName(String)

获取一个成员资格用户的集合，其中的用户名包含要匹配的指定用户名。

public:
 static System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch);

public static System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch);

static member FindUsersByName : string -> System.Web.Security.MembershipUserCollection

Public Shared Function FindUsersByName (usernameToMatch As String) As MembershipUserCollection

参数

usernameToMatch: String

要搜索的用户名。

MembershipUserCollection

一个 MembershipUserCollection 集合，其中包含与 usernameToMatch 参数匹配的所有用户。

删除 usernameToMatch 参数值的前导和尾随空格。

例外

ArgumentException

usernameToMatch 是一个空字符串。

ArgumentNullException

usernameToMatch 为 null。

示例

下面的代码示例使用 FindUsersByName 该方法根据用户输入从成员身份数据库中检索成员身份用户信息，并在数据页中显示结果。

重要

此示例包含接受用户输入的文本框，这是潜在的安全威胁。默认情况下，ASP.NET 网页验证用户输入是否不包含脚本或 HTML 元素。有关详细信息，请参阅脚本侵入概述。

<%@ 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>

<%@ 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">

Public Sub GoButton_OnClick(sender As Object, args As EventArgs)
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text)
  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>

  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>

注解

FindUsersByName返回成员身份用户的列表，其中用户名与配置的usernameToMatch``applicationName用户名匹配。

对 SqlMembershipProvider 参数使用 LIKE 子句 usernameToMatch 执行其搜索。 LIKE 子句中SQL Server支持的任何通配符都可以在参数值中使用usernameToMatch。

从所有参数值中剪裁前导空格和尾随空格。

另请参阅

ASP.NET 成员资格简介

适用于

FindUsersByName(String, Int32, Int32, Int32)

获取一个成员资格用户的集合，并显示在一个数据页中，这些用户的用户名包含要匹配的指定用户名。

public:
 static System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public static System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

static member FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection

Public Shared Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection

参数

usernameToMatch: String

要搜索的用户名。

pageIndex: Int32

要返回的结果页的索引。 pageIndex 从零开始。

pageSize: Int32

要返回的结果页的大小。

totalRecords: Int32

匹配用户的总数。

MembershipUserCollection

包含一页 pageSizeMembershipUser 对象的 MembershipUserCollection，这些对象从 pageIndex 指定的页开始。

删除 usernameToMatch 参数值的前导和尾随空格。

例外

ArgumentException

usernameToMatch 是一个空字符串。

或 - pageIndex 小于零。
或 - pageSize 小于 1。

ArgumentNullException

usernameToMatch 为 null。

示例

下面的代码示例使用 FindUsersByName 该方法根据用户输入从成员身份数据库中检索成员身份用户信息，并在数据页中显示结果。

重要

<%@ 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">

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;
    GetUsers();
    return;
  }

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

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

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

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

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

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

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

</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:Panel id="NavigationPanel" Visible="false" runat="server">
    <table border="0" cellpadding="3" cellspacing="3">
      <tr>
        <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>
      </tr>
    </table>
  </asp:Panel>

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

</form>

</body>
</html>

<%@ 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 pageSize As Integer = 5
Dim totalUsers As Integer
Dim totalPages As Integer
Dim currentPage As Integer = 1

Private Sub GetUsers()
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text, _
                          currentPage - 1, pageSize, totalUsers)

  totalPages = ((totalUsers - 1) \ pageSize) + 1

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

  If currentPage > totalPages Then
    currentPage = totalPages
    GetUsers()
    Return
  End If

  UserGrid.DataBind()
  CurrentPageLabel.Text = currentPage.ToString()
  TotalPagesLabel.Text = totalPages.ToString()

  If currentPage = totalPages Then
    NextButton.Visible = False
  Else
    NextButton.Visible = True
  End If

  If currentPage = 1 Then
    PreviousButton.Visible = False
  Else
    PreviousButton.Visible = True
  End If

  If totalUsers <= 0 Then
    NavigationPanel.Visible = False
  Else
    NavigationPanel.Visible = True
  End If
End Sub

Public Sub NextButton_OnClick(sender As Object, args As EventArgs)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text)
  currentPage += 1
  GetUsers()
End Sub

Public Sub PreviousButton_OnClick(sender As Object, args As EventArgs)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text)
  currentPage -= 1
  GetUsers()
End Sub

Public Sub GoButton_OnClick(sender As Object, args As EventArgs)
  currentPage = 1
  GetUsers()
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>

  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">
      <tr>
        <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>
      </tr>
    </table>
  </asp:Panel>

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

</form>

</body>
</html>

注解

FindUsersByName返回成员身份用户的列表，其中用户名与配置的usernameToMatch``applicationName用户名匹配。

对 SqlMembershipProvider 参数使用 LIKE 子句 usernameToMatch 执行其搜索。 LIKE 子句中SQL Server支持的任何通配符都可以在参数值中使用usernameToMatch。

返回 FindUsersByName 的结果受 pageIndex 参数 pageSize 的约束。该pageSize参数标识要在 . MembershipUserCollection中返回的最大对象数MembershipUser。参数 pageIndex 标识要返回的结果页，其中 0 标识第一页。该 totalRecords 参数是一个 out 参数，该参数设置为与值匹配 usernameToMatch 的成员身份用户总数。例如，如果在匹配部分或整个用户名的位置 usernameToMatch 找到 13 个用户，并且 pageIndex 值为 1，值为 pageSize 5，则 MembershipUserCollection 返回的用户将包含返回的第六到第十个用户。 totalRecords 将设置为 13。

另请参阅

ASP.NET 成员资格简介

适用于

Membership.FindUsersByName 方法

定义

重载

FindUsersByName(String)

参数

返回

例外

示例

注解

另请参阅

适用于

FindUsersByName(String, Int32, Int32, Int32)

参数

返回

例外

示例

注解

另请参阅

适用于

其他资源