WindowsTokenRoleProvider.IsUserInRole Metod

Definition

Namnområde:: System.Web.Security

Sammansättning:: System.Web.dll

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

Hämtar ett värde som anger om den angivna användaren finns i den angivna inbyggda Windows rollen.

Överlagringar

Name	Description
IsUserInRole(String, WindowsBuiltInRole)	Hämtar ett värde som anger om den angivna användaren finns i den angivna inbyggda Windows rollen.
IsUserInRole(String, String)	Hämtar ett värde som anger om den angivna användaren finns i den angivna Windows gruppen.

IsUserInRole(String, WindowsBuiltInRole)

Hämtar ett värde som anger om den angivna användaren finns i den angivna inbyggda Windows rollen.

public:
 bool IsUserInRole(System::String ^ username, System::Security::Principal::WindowsBuiltInRole role);

public bool IsUserInRole(string username, System.Security.Principal.WindowsBuiltInRole role);

override this.IsUserInRole : string * System.Security.Principal.WindowsBuiltInRole -> bool

Public Function IsUserInRole (username As String, role As WindowsBuiltInRole) As Boolean

Parametrar

username: String

Användarnamnet som ska sökas efter i formuläret DOMÄN\användarnamn.

role: WindowsBuiltInRole

Den Windows roll som ska sökas in.

Returer

Boolean

true om den angivna användaren har den angivna Windows rollen, annars false.

Undantag

ArgumentNullException

username är null.

ProviderException

Den körda användaren har inte någon autentiserad WindowsIdentity kopplad till User. För icke-HTTP-scenarier har den användare som körs inte någon autentiserad bifogad WindowsIdentity till CurrentPrincipal.

-eller-

username matchar inte för Name den aktuella WindowsIdentity.

Exempel

I följande kodexempel kontrolleras programmatiskt om den inloggade användaren är i rollen Administratörer innan användaren kan visa rollinformation för programmet. Ett exempel på en Web.config fil som aktiverar rollhantering finns i WindowsTokenRoleProvider.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Security.Principal" %>
<!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;

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

  WindowsPrincipal p = (WindowsPrincipal)System.Threading.Thread.CurrentPrincipal;

  if (!p.IsInRole(WindowsBuiltInRole.Administrator))
  {
    Msg.Text = "You are not authorized to view user roles.";
    return;
  }


  // Bind roles to GridView.

  try
  {
    rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }

  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</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: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

Public Sub Page_Load()
  Msg.Text = ""

  Dim provider As WindowsTokenRoleProvider = CType(Roles.Provider, WindowsTokenRoleProvider)

  If Not provider.IsUserInRole(User.Identity.Name, _
                               System.Security.Principal.WindowsBuiltInRole.Administrator) Then
    Msg.Text = "You are not authorized to view user roles."
    Return
  End If


  ' Bind roles to GridView.

  Try
    rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try

  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
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: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>

Kommentarer

Med metoden IsUserInRole kan du kontrollera om en användare finns i någon av de vanliga Windows roller som beskrivs i uppräkningen WindowsBuiltInRole. Den här metoden är användbar för program som är lokaliserade till flera språk. Den här överlagringen IsUserInRole av metoden är inte en del av basklassen RoleProvider och kan endast nås genom att egenskapen Provider för klassen tilldelas Roles som WindowsTokenRoleProvider typ.

Du kan bara anropa IsUserInRole metoden för den inloggade användaren, vilket identifieras av LOGON_USER-servervariabeln. Om värdet som anges i parametern username inte är namnet på den inloggade användaren genereras en HttpException .

IsUserInRole -metoden kan bara anropas för den inloggade användare som identifieras av LOGON_USER-servervariabeln. Den aktuella inloggade användaren måste vara en Windows autentiserad användare. Mer information om ASP.NET och Windows authentication finns i ASP.NET Authentication.

Se även

Förstå ASP.NET rollhantering

Gäller för

IsUserInRole(String, String)

Hämtar ett värde som anger om den angivna användaren finns i den angivna Windows gruppen.

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

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

override this.IsUserInRole : string * string -> bool

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

Parametrar

username: String

Användarnamnet som ska sökas efter i formuläret DOMÄN\användarnamn.

roleName: String

Den Windows grupp som ska söka i formuläret DOMÄN\rolename.

Returer

Boolean

true om det angivna användarnamnet finns i den angivna Windows gruppen, annars false.

Undantag

ArgumentNullException

username är null.

-eller-

roleName är null.

ProviderException

-eller-

username matchar inte för Name den aktuella WindowsIdentity.

-eller-

Ett fel uppstod när användarens Windows gruppinformation skulle hämtas.

Exempel

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

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

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


  // Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</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: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

Public Sub Page_Load()
  Msg.Text = ""

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

  ' Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
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: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>

Kommentarer

Metoden IsUserInRole anropas av klassen Roles och metoden IsInRole för egenskapen User för att avgöra om en användare finns i en Windows grupp. Du kan bara anropa IsUserInRole metoden för den inloggade användaren, vilket identifieras av LOGON_USER-servervariabeln. Den aktuella inloggade användaren måste vara en Windows autentiserad användare. Mer information om ASP.NET och Windows authentication finns i ASP.NET Authentication.

Se även

Förstå ASP.NET rollhantering

Gäller för

Feedback

Var den här sidan till hjälp?