SqlMembershipProvider.FindUsersByName(String, Int32, Int32, Int32) メソッド

リファレンス

定義

名前空間:: System.Web.Security

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ユーザー名が指定内容と一致するメンバーシップユーザーのコレクションを取得します。

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

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

override this.FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection

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

パラメーター

usernameToMatch: String

検索するユーザー名。

pageIndex: Int32

返される結果ページのインデックス。 pageIndex は 0 から始まります。

pageSize: Int32

取得する結果のページのサイズ。

totalRecords: Int32

このメソッドから制御が戻るとき、一致するユーザーの総数を格納します。

戻り値

MembershipUserCollection

pageSize で指定されたページから始まる pageIndexMembershipUserCollection オブジェクトのページを格納している MembershipUser。

例外

ArgumentException

usernameToMatch が空の文字列 ("") であるか、または 256 文字を超えています。

- または -

pageIndex が 0 未満です。

- または -

pageSize が 1 未満です。

または

pageIndex にプラス 1 を pageSize 掛 pageSize けた値が Int32.MaxValue を超えています。

ArgumentNullException

usernameToMatch は null です。

例

次のコード例では、メソッドを FindUsersByName 使用してメンバーシップユーザー情報を取得し、結果をデータのページに表示します。

注意

この例では、System.Web.Security.SqlMembershipProvider を使用して、 SqlMembershipProvider Web.config ファイル内のとして指定されたを defaultProvider 呼び出します。型SqlMembershipProviderとして既定のプロバイダーにアクセスする必要がある場合は、クラスのプロパティをProvider Membershipキャストできます。特定のプロバイダーの種類として他の構成済みプロバイダーにアクセスするには、クラスのプロパティを使用して構成された名前で Providers アクセスし、特定のプロバイダーの Membership 種類としてキャストします。

<%@ 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 一致するユーザー名を検索します。 SQL Serverワイルドカード文字をパラメーター値に含めることができます。たとえば、パラメーターが usernameToMatch "user1" に設定されている場合、ユーザー名が "user1" のユーザーのユーザー情報が返されます (存在する場合)。パラメーターが usernameToMatch "user%" に設定されている場合は、ユーザー名が "user1"、"user2"、"user_admin" などのユーザーのユーザー情報が返されます。

によってFindUsersByName返される結果は、パラメーターと pageSize パラメーターによってpageIndex制限されます。パラメーターは pageSize 、で返されるオブジェクトの MembershipUser 最大数を MembershipUserCollection識別します。パラメーターは pageIndex 、返す結果のページを識別します。0 は最初のページを識別します。パラメーターは totalRecords 、 out 構成 applicationNameされたのメンバーシップユーザーの合計数に設定されるパラメーターです。たとえば、構成された applicationNamepageIndex に 13 人のユーザーがいて、値が 1 で、 pageSize が 5 の場合、MembershipUserCollection返されるには、返された 6 番目から 10 番目のユーザーが含まれます。パラメーターは totalRecords 13 に設定されます。

usernameToMatch パラメーター値の先頭と末尾の空白はトリムされます。

適用対象

こちらもご覧ください

ASP.NET メンバーシップの概要

SqlMembershipProvider.FindUsersByName(String, Int32, Int32, Int32) メソッド

定義

パラメーター

戻り値

例外

例

注釈

適用対象

こちらもご覧ください

フィードバック

その他のリソース