Roles.IsUserInRole Méthode

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 valeur indiquant si un utilisateur se trouve dans le rôle spécifié.

Surcharges

Nom	Description
IsUserInRole(String)	Obtient une valeur indiquant si l’utilisateur actuellement connecté se trouve dans le rôle spécifié. L’API est destinée uniquement à être appelée dans le contexte d’un thread de requête ASP.NET, et dans ce cas d’usage approuvé, il s’agit d’un thread sécurisé.
IsUserInRole(String, String)	Obtient une valeur indiquant si l’utilisateur spécifié se trouve dans le rôle spécifié. L’API est destinée uniquement à être appelée dans le contexte d’un thread de requête ASP.NET, et dans ce cas d’usage approuvé, il s’agit d’un thread sécurisé.

IsUserInRole(String)

Obtient une valeur indiquant si l’utilisateur actuellement connecté se trouve dans le rôle spécifié. L’API est destinée uniquement à être appelée dans le contexte d’un thread de requête ASP.NET, et dans ce cas d’usage approuvé, il s’agit d’un thread sécurisé.

public:
 static bool IsUserInRole(System::String ^ roleName);

public static bool IsUserInRole(string roleName);

static member IsUserInRole : string -> bool

Public Shared Function IsUserInRole (roleName As String) As Boolean

Paramètres

roleName: String

Nom du rôle dans lequel effectuer une recherche.

Retours

Boolean

true si l’utilisateur actuellement connecté se trouve dans le rôle spécifié ; sinon, false.

Exceptions

ArgumentNullException

roleName a la valeur null.

- ou -

Il n’existe aucun utilisateur connecté actuel.

ArgumentException

roleName est une chaîne vide ou contient une virgule (,).

ProviderException

La gestion des rôles n’est pas activée.

Exemples

L’exemple de code suivant vérifie par programmation si l’utilisateur actuellement connecté se trouve dans le rôle Administrateurs avant de permettre à l’utilisateur d’afficher les paramètres de rôles pour l’application. Pour obtenir un exemple de fichier Web.config qui active la gestion des rôles, consultez Roles.

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

string[] rolesArray;
MembershipUserCollection users;

public void Page_Load()
{
  Msg.Text = "";

  try
  {
    if (!Roles.IsUserInRole(User.Identity.Name, "Administrators"))
    {
      Msg.Text = "You are not authorized to view user roles.";
      UsersListBox.Visible = false;
      return;
    }
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }


  if (!IsPostBack)
  {
    // Bind users to ListBox.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;
    UsersListBox.DataBind();
  }


  // If a user is selected, show the roles for the selected user.

  if (UsersListBox.SelectedItem != null)
  {
    // Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
    UserRolesGrid.DataSource = rolesArray;
    UserRolesGrid.DataBind();

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + UsersListBox.SelectedItem.Value;
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                    Rows="8" AutoPostBack="true" runat="server" /></td>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</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 rolesArray() As String
Dim users As MembershipUserCollection

Public Sub Page_Load()

  Msg.Text = ""

  Try
    If Not Roles.IsUserInRole(User.Identity.Name, "Administrators") Then
      Msg.Text = "You are not authorized to view user roles."
      UsersListBox.Visible = False
      Return
    End If
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try


  If Not IsPostBack Then
    ' Bind users to ListBox.

    users = Membership.GetAllUsers()
    UsersListBox.DataSource = users
    UsersListBox.DataBind()
  End If


  ' If a user is selected, show the roles for the selected user.

  If Not UsersListBox.SelectedItem Is Nothing Then
    ' Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value)
    UserRolesGrid.DataSource = rolesArray
    UserRolesGrid.DataBind()

    UserRolesGrid.Columns(0).HeaderText = "Roles for " & UsersListBox.SelectedItem.Value
  End If

End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                    Rows="8" AutoPostBack="true" runat="server" /></td>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Remarques

La IsUserInRole méthode appelle la RoleProvider.IsUserInRole méthode du fournisseur de rôles par défaut pour déterminer si l’utilisateur actuellement connecté est associé à un rôle à partir de la source de données de l’application spécifiée dans la ApplicationName propriété. L’utilisateur actuellement connecté est identifié par la HttpContext.User propriété de l’environnement actuel System.Web.HttpContextou pour Thread.CurrentPrincipal les environnements d’hébergement non HTTP. Si aucun utilisateur n’est connecté, une exception est levée. Seuls les rôles de l’application spécifiée dans la ApplicationName propriété sont récupérés.

Si CacheRolesInCookie c’est truele cas, il est possible roleName d’effectuer une vérification sur le cache des rôles plutôt que sur le fournisseur de rôles spécifié.

Voir aussi

Présentation de la gestion des rôles ASP.NET

S’applique à

IsUserInRole(String, String)

Obtient une valeur indiquant si l’utilisateur spécifié se trouve dans le rôle spécifié. L’API est destinée uniquement à être appelée dans le contexte d’un thread de requête ASP.NET, et dans ce cas d’usage approuvé, il s’agit d’un thread sécurisé.

public:
 static bool IsUserInRole(System::String ^ username, System::String ^ roleName);

public static bool IsUserInRole(string username, string roleName);

static member IsUserInRole : string * string -> bool

Public Shared Function IsUserInRole (username As String, roleName As String) As Boolean

Paramètres

username: String

Nom de l’utilisateur à rechercher.

roleName: String

Nom du rôle dans lequel effectuer une recherche.

Retours

Boolean

true si l’utilisateur spécifié se trouve dans le rôle spécifié ; sinon, false.

Exceptions

ArgumentNullException

roleName a la valeur null.

- ou -

username a la valeur null.

ArgumentException

roleName est une chaîne vide ou contient une virgule (,).

- ou -

username contient une virgule (,).

ProviderException

La gestion des rôles n’est pas activée.

Exemples

L’exemple de code suivant vérifie par programmation si un utilisateur se trouve dans le rôle Administrateurs avant de permettre à l’utilisateur d’afficher les paramètres des rôles pour l’application. Pour obtenir un exemple de fichier Web.config qui active la gestion des rôles, consultez Roles.

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

string[] rolesArray;
MembershipUserCollection users;

public void Page_Load()
{
  Msg.Text = "";

  try
  {
    if (!Roles.IsUserInRole(User.Identity.Name, "Administrators"))
    {
      Msg.Text = "You are not authorized to view user roles.";
      UsersListBox.Visible = false;
      return;
    }
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }


  if (!IsPostBack)
  {
    // Bind users to ListBox.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;
    UsersListBox.DataBind();
  }


  // If a user is selected, show the roles for the selected user.

  if (UsersListBox.SelectedItem != null)
  {
    // Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
    UserRolesGrid.DataSource = rolesArray;
    UserRolesGrid.DataBind();

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + UsersListBox.SelectedItem.Value;
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                    Rows="8" AutoPostBack="true" runat="server" /></td>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</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 rolesArray() As String
Dim users As MembershipUserCollection

Public Sub Page_Load()

  Msg.Text = ""

  Try
    If Not Roles.IsUserInRole(User.Identity.Name, "Administrators") Then
      Msg.Text = "You are not authorized to view user roles."
      UsersListBox.Visible = False
      Return
    End If
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try


  If Not IsPostBack Then
    ' Bind users to ListBox.

    users = Membership.GetAllUsers()
    UsersListBox.DataSource = users
    UsersListBox.DataBind()
  End If


  ' If a user is selected, show the roles for the selected user.

  If Not UsersListBox.SelectedItem Is Nothing Then
    ' Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value)
    UserRolesGrid.DataSource = rolesArray
    UserRolesGrid.DataBind()

    UserRolesGrid.Columns(0).HeaderText = "Roles for " & UsersListBox.SelectedItem.Value
  End If

End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                    Rows="8" AutoPostBack="true" runat="server" /></td>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Remarques

La IsUserInRole méthode appelle la IsUserInRole méthode du fournisseur de rôles par défaut pour déterminer si un nom d’utilisateur est associé à un rôle à partir de la source de données de l’application spécifiée dans la ApplicationName propriété.

Si username elle est égale à l’utilisateur connecté actuel et que la valeur de la CacheRolesInCookie propriété est true, roleName peut être vérifiée sur le cache de rôle plutôt que sur le paramètre spécifié Provider.

Voir aussi

Présentation de la gestion des rôles ASP.NET

S’applique à

Commentaires

Cette page a-t-elle été utile ?

Partager via

Roles.IsUserInRole Méthode

Définition

Surcharges

IsUserInRole(String)

Paramètres

Retours

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

IsUserInRole(String, String)

Paramètres

Retours

Exceptions

Exemples

Remarques

Voir aussi

S’applique à

Commentaires