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 Web 網頁會驗證使用者輸入未包含指令碼或 HTML 項目。如需詳細資訊，請參閱 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>

<%@ 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會傳回成員資格使用者的清單，其中用戶名稱符合所applicationName設定所提供的 usernameToMatch 。

會 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

MembershipUserCollection，其中包含 pageSizeMembershipUser 物件的頁面，從 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會傳回成員資格使用者的清單，其中用戶名稱符合所applicationName設定所提供的 usernameToMatch 。

會 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)

參數

傳回

例外狀況

範例

備註

另請參閱

適用於

其他資源