SqlMembershipProvider.FindUsersByName(String, Int32, Int32, Int32) Méthode

Référence

Définition

Espace de noms:: System.Web.Security

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Obtient une collection d'utilisateurs d'appartenance dont le nom d'utilisateur correspond au nom spécifié.

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

Paramètres

usernameToMatch: String

Nom d'utilisateur à rechercher.

pageIndex: Int32

Index de la page de résultats à retourner. pageIndex est de base zéro.

pageSize: Int32

Taille de la page de résultats à retourner.

totalRecords: Int32

Lorsque cette méthode est retournée, contient le nombre total d'utilisateurs correspondant.

Retours

MembershipUserCollection

MembershipUserCollection qui contient une page d’objets pageSizeMembershipUser commençant à la page spécifiée par pageIndex.

Exceptions

ArgumentException

usernameToMatch est une chaîne vide ("") ou dépasse 256 caractères.

- ou -

pageIndex est inférieur à zéro.

- ou -

pageSize est inférieur à 1.

- ou -

pageIndex multiplié par pageSize plus pageSize un dépasse Int32.MaxValue.

ArgumentNullException

usernameToMatch a la valeur null.

Exemples

L’exemple de code suivant utilise la FindUsersByName méthode pour récupérer les informations utilisateur d’appartenance et affiche les résultats dans des pages de données.

Notes

Cet exemple utilise System.Web.Security.SqlMembershipProvider pour appeler le SqlMembershipProvider spécifié en tant que defaultProvider dans le fichier Web.config. Si vous devez accéder au fournisseur par défaut en tant que type SqlMembershipProvider, vous pouvez caster la Provider propriété de la Membership classe . Pour accéder à d’autres fournisseurs configurés en tant que type de fournisseur spécifique, vous pouvez y accéder par leur nom configuré avec la Providers propriété de la Membership classe et les convertir en type de fournisseur spécifique.

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

Remarques

FindUsersByName retourne une liste d’utilisateurs d’appartenance pour lesquels le nom d’utilisateur contient une correspondance avec le fourni usernameToMatch pour le configuré ApplicationName.

Recherche SqlMembershipProvider un nom d’utilisateur qui correspond à la valeur du paramètre, à l’aide usernameToMatch de la clause LIKE. SQL Server caractères génériques peuvent être inclus avec la valeur du paramètre. Par exemple, si le usernameToMatch paramètre est défini sur « user1 », les informations utilisateur de l’utilisateur portant le nom d’utilisateur « user1 » sont retournées, le cas échéant. Si le usernameToMatch paramètre est défini sur « user% », les informations utilisateur pour les utilisateurs portant le nom d’utilisateur « user1 », « user2 », « user_admin », etc. sont retournées.

Les résultats retournés par FindUsersByName sont limités par les pageIndex paramètres et pageSize . Le pageSize paramètre identifie le nombre maximal d’objets MembershipUser à retourner dans le MembershipUserCollection. Le pageIndex paramètre identifie la page de résultats à retourner, où zéro identifie la première page. Le totalRecords paramètre est un out paramètre qui est défini sur le nombre total d’utilisateurs d’appartenance pour le configuré applicationName. Par exemple, s’il y a 13 utilisateurs pour le configuré applicationNameet que la pageIndex valeur était 1 avec un pageSize de 5, le MembershipUserCollection retourné contiendrait le sixième au dixième utilisateurs retournés. Le totalRecords paramètre est défini sur 13.

Les espaces à gauche et à droite sont retirés de la valeur de paramètre usernameToMatch.

S’applique à

Voir aussi

Présentation de l’appartenance ASP.NET

SqlMembershipProvider.FindUsersByName(String, Int32, Int32, Int32) Méthode

Définition

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

Voir aussi

Commentaires

Ressources supplémentaires