Membership.FindUsersByName Méthode

  • Référence

Définition

Espace de noms:
System.Web.Security
Assembly:
System.Web.dll

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

Surcharges

FindUsersByName(String)

Obtient une collection d'utilisateurs d'appartenance dont le nom d'utilisateur correspond au nom spécifié.
FindUsersByName(String, Int32, Int32, Int32)

Obtient une collection d'utilisateurs d'appartenance dont le nom d'utilisateur correspond au nom spécifié, sous forme de page de données.

FindUsersByName(String)

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

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

Paramètres

usernameToMatch
String

Nom d'utilisateur à rechercher.

Retours

MembershipUserCollection

Une MembershipUserCollection qui contient tous les utilisateurs correspondant au paramètre usernameToMatch.

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

Exceptions

ArgumentException

usernameToMatch est une chaîne vide.

ArgumentNullException

usernameToMatch a la valeur null.

Exemples

L’exemple de code suivant utilise la FindUsersByName méthode pour récupérer des informations utilisateur d’appartenance à partir de la base de données d’appartenance en fonction de l’entrée utilisateur et affiche les résultats dans les pages de données.

Important

Cet exemple contient une zone de texte qui accepte l’entrée utilisateur, qui est une menace de sécurité potentielle. Par défaut, les pages web ASP.NET vérifient que l’entrée d’utilisateur n’inclut pas de script ou d’éléments HTML. Pour plus d’informations, consultez Vue d’ensemble des attaques de script.

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

Remarques

FindUsersByName retourne une liste d’utilisateurs d’appartenance où le nom d’utilisateur correspond au nom d’utilisateur fourni usernameToMatch pour le fichier configuré applicationName.

La SqlMembershipProvider recherche effectue sa recherche à l’aide d’une clause LIKE par rapport au usernameToMatch paramètre. Tous les caractères génériques pris en charge par SQL Server dans les clauses LIKE peuvent être utilisés dans la valeur du usernameToMatch paramètre.

Les espaces de début et de fin sont supprimés de toutes les valeurs de paramètre.

Voir aussi

S’applique à

FindUsersByName(String, Int32, Int32, Int32)

Obtient une collection d'utilisateurs d'appartenance dont le nom d'utilisateur correspond au nom spécifié, sous forme de page de données.

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

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

Nombre total d’utilisateurs correspondants.

Retours

MembershipUserCollection

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

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

Exceptions

ArgumentException

usernameToMatch est une chaîne vide.

  • ou - pageIndex est inférieur à zéro.

  • ou - pageSize est inférieur à 1.

ArgumentNullException

usernameToMatch a la valeur null.

Exemples

L’exemple de code suivant utilise la FindUsersByName méthode pour récupérer des informations utilisateur d’appartenance à partir de la base de données d’appartenance en fonction de l’entrée utilisateur et affiche les résultats dans les pages de données.

Important

Cet exemple contient une zone de texte qui accepte l’entrée utilisateur, qui est une menace de sécurité potentielle. Par défaut, les pages web ASP.NET vérifient que l’entrée d’utilisateur n’inclut pas de script ou d’éléments HTML. Pour plus d’informations, consultez Vue d’ensemble des attaques de script.

<%@ 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 où le nom d’utilisateur correspond au nom d’utilisateur fourni usernameToMatch pour le fichier configuré applicationName.

La SqlMembershipProvider recherche effectue sa recherche à l’aide d’une clause LIKE par rapport au usernameToMatch paramètre. Tous les caractères génériques pris en charge par SQL Server dans les clauses LIKE peuvent être utilisés dans la valeur du usernameToMatch paramètre.

Les résultats retournés par FindUsersByName sont limités par les paramètres et pageSize les pageIndex paramètres. Le pageSize paramètre identifie le nombre maximal d’objets MembershipUser à retourner dans le MembershipUserCollection. Le pageIndex paramètre identifie la page des résultats à retourner, où 0 identifie la première page. Le totalRecords paramètre est un out paramètre défini sur le nombre total d’utilisateurs d’appartenance correspondant à la usernameToMatch valeur. Par exemple, si 13 utilisateurs ont été trouvés lorsqu’ils usernameToMatch correspondent à une partie ou à l’ensemble du nom d’utilisateur, et que la pageIndex valeur était 1 avec une pageSize valeur de 5, le MembershipUserCollection retour contiendrait le sixième au dixième utilisateur retourné. totalRecords est défini sur 13.

Voir aussi

S’applique à