WindowsPrincipal.IsInRole 方法

public:
 virtual bool IsInRole(int rid);

public virtual bool IsInRole(int rid);

override this.IsInRole : int -> bool

abstract member IsInRole : int -> bool
override this.IsInRole : int -> bool

Public Overridable Function IsInRole (rid As Integer) As Boolean

參數

傳回

true 若現任負責人是指定Windows使用者群組成員，即特定角色;否則為 false。

範例

以下程式碼範例展示了這些 IsInRole 方法的使用方法。 列 WindowsBuiltInRole 舉作為識別內建角色的 RID 來源。 RID用來決定現任校長的角色。

public:
   static void DemonstrateWindowsBuiltInRoleEnum()
   {
      AppDomain^ myDomain = Thread::GetDomain();

      myDomain->SetPrincipalPolicy( PrincipalPolicy::WindowsPrincipal );
      WindowsPrincipal^ myPrincipal = dynamic_cast<WindowsPrincipal^>(Thread::CurrentPrincipal);

      Console::WriteLine( "{0} belongs to: ", myPrincipal->Identity->Name );

      Array^ wbirFields = Enum::GetValues( WindowsBuiltInRole::typeid );

      for each ( Object^ roleName in wbirFields )
      {
         try
         {
            Console::WriteLine( "{0}? {1}.", roleName,
               myPrincipal->IsInRole(  *dynamic_cast<WindowsBuiltInRole^>(roleName) ) );
         }
         catch ( Exception^ ) 
         {
            Console::WriteLine( "{0}: Could not obtain role for this RID.",
               roleName );
         }
      }
   }

using System;
using System.Threading;
using System.Security.Permissions;
using System.Security.Principal;

class SecurityPrincipalDemo
{
    public static void DemonstrateWindowsBuiltInRoleEnum()
    {
        AppDomain myDomain = Thread.GetDomain();

        myDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal);
        WindowsPrincipal myPrincipal = (WindowsPrincipal)Thread.CurrentPrincipal;
        Console.WriteLine("{0} belongs to: ", myPrincipal.Identity.Name.ToString());
        Array wbirFields = Enum.GetValues(typeof(WindowsBuiltInRole));
        foreach (object roleName in wbirFields)
        {
            try
            {
                // Cast the role name to a RID represented by the WindowsBuildInRole value.
                Console.WriteLine("{0}? {1}.", roleName,
                    myPrincipal.IsInRole((WindowsBuiltInRole)roleName));
                Console.WriteLine("The RID for this role is: " + ((int)roleName).ToString());
            }
            catch (Exception)
            {
                Console.WriteLine("{0}: Could not obtain role for this RID.",
                    roleName);
            }
        }
        // Get the role using the string value of the role.
        Console.WriteLine("{0}? {1}.", "Administrators",
            myPrincipal.IsInRole("BUILTIN\\" + "Administrators"));
        Console.WriteLine("{0}? {1}.", "Users",
            myPrincipal.IsInRole("BUILTIN\\" + "Users"));
        // Get the role using the WindowsBuiltInRole enumeration value.
        Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator,
           myPrincipal.IsInRole(WindowsBuiltInRole.Administrator));
        // Get the role using the WellKnownSidType.
        SecurityIdentifier sid = new SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, null);
        Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid  {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid));
    }

    public static void Main()
    {
        DemonstrateWindowsBuiltInRoleEnum();
    }
}

Imports System.Threading
Imports System.Security.Permissions
Imports System.Security.Principal

Class SecurityPrincipalDemo

    Public Shared Sub DemonstrateWindowsBuiltInRoleEnum()
        Dim myDomain As AppDomain = Thread.GetDomain()

        myDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal)
        Dim myPrincipal As WindowsPrincipal = CType(Thread.CurrentPrincipal, WindowsPrincipal)
        Console.WriteLine("{0} belongs to: ", myPrincipal.Identity.Name.ToString())
        Dim wbirFields As Array = [Enum].GetValues(GetType(WindowsBuiltInRole))
        Dim roleName As Object
        For Each roleName In wbirFields
            Try
                ' Cast the role name to a RID represented by the WindowsBuildInRole value.
                Console.WriteLine("{0}? {1}.", roleName, myPrincipal.IsInRole(CType(roleName, WindowsBuiltInRole)))
                Console.WriteLine("The RID for this role is: " + Fix(roleName).ToString())

            Catch
                Console.WriteLine("{0}: Could not obtain role for this RID.", roleName)
            End Try
        Next roleName
        ' Get the role using the string value of the role.
        Console.WriteLine("{0}? {1}.", "Administrators", myPrincipal.IsInRole("BUILTIN\" + "Administrators"))
        Console.WriteLine("{0}? {1}.", "Users", myPrincipal.IsInRole("BUILTIN\" + "Users"))
        ' Get the role using the WindowsBuiltInRole enumeration value.
        Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator, myPrincipal.IsInRole(WindowsBuiltInRole.Administrator))
        ' Get the role using the WellKnownSidType.
        Dim sid As New SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, Nothing)
        Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid  {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid))

    End Sub

    Public Shared Sub Main()
        DemonstrateWindowsBuiltInRoleEnum()

    End Sub
End Class

備註

在測試新建立的角色資訊（如新使用者或新群組）時，務必登出再登入，以強制角色資訊在網域內傳播。 如果不這麼做，測試可能會 IsInRole 回到 false。

出於效能考量，建議以 IsInRole(SecurityIdentifier) 過載作為決定使用者角色的首選過載值。

相對識別碼（RID）是 Windows 使用者群組安全識別碼（SID）的組成部分，並被支援以防止跨平台在地化問題。 許多使用者帳號、本地群組和全域群組的預設 RID 值在所有 Windows 版本中都是固定的。

例如，BUILTIN\Administrators 角色的 RID 是 0x220。 若現任負責人是管理員，使用0x220作為方法的輸入參數 IsInRole ，則會 true 被回傳。

以下表格列出預設的RID值。

public:
 virtual bool IsInRole(System::Security::Principal::SecurityIdentifier ^ sid);

public virtual bool IsInRole(System.Security.Principal.SecurityIdentifier sid);

[System.Runtime.InteropServices.ComVisible(false)]
public virtual bool IsInRole(System.Security.Principal.SecurityIdentifier sid);

override this.IsInRole : System.Security.Principal.SecurityIdentifier -> bool

[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member IsInRole : System.Security.Principal.SecurityIdentifier -> bool
override this.IsInRole : System.Security.Principal.SecurityIdentifier -> bool

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.IsInRole : System.Security.Principal.SecurityIdentifier -> bool

Public Overridable Function IsInRole (sid As SecurityIdentifier) As Boolean

參數

傳回

true 若現任負責人是指定Windows使用者群組成員;否則為 false。

屬性

ComVisibleAttribute

例外狀況

範例

以下程式碼範例示範了此 WindowsPrincipal.IsInRole(SecurityIdentifier) 方法的使用。 BuiltinAdministratorsSid列舉值用來判斷現任負責人是否為管理人員。 完整程式碼範例請參見方法。WindowsPrincipal.IsInRole(Int32)

// Get the role using the WellKnownSidType.
SecurityIdentifier sid = new SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, null);
Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid  {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid));

    ' Get the role using the WellKnownSidType.
    Dim sid As New SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, Nothing)
    Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid  {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid))

End Sub

備註

SecurityIdentifier 唯一識別 Windows 上的使用者或群組。 在測試新建立的角色資訊（如新使用者或新群組）時，務必登出再登入，以強制角色資訊在網域內傳播。 如果不這麼做，測試可能會 IsInRole 回到 false。

出於效能考量，這是決定使用者角色的首選超載方式。

public:
 virtual bool IsInRole(System::Security::Principal::WindowsBuiltInRole role);

public virtual bool IsInRole(System.Security.Principal.WindowsBuiltInRole role);

override this.IsInRole : System.Security.Principal.WindowsBuiltInRole -> bool

abstract member IsInRole : System.Security.Principal.WindowsBuiltInRole -> bool
override this.IsInRole : System.Security.Principal.WindowsBuiltInRole -> bool

Public Overridable Function IsInRole (role As WindowsBuiltInRole) As Boolean

參數

傳回

true 若現任負責人是指定Windows使用者群組成員;否則為 false。

例外狀況

範例

以下範例使用 WindowsBuiltInRole 列舉來判斷當前主體是否為 Administrator。 完整程式碼範例請參見方法。WindowsPrincipal.IsInRole(Int32)

// Get the role using the WindowsBuiltInRole enumeration value.
Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator,
   myPrincipal.IsInRole(WindowsBuiltInRole.Administrator));

' Get the role using the WindowsBuiltInRole enumeration value.
Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator, myPrincipal.IsInRole(WindowsBuiltInRole.Administrator))

備註

在測試新建立的角色資訊（如新使用者或新群組）時，務必登出再登入，以強制角色資訊在網域內傳播。 如果不這麼做，測試可能會 IsInRole 回到 false。

出於效能考量，建議以 IsInRole(SecurityIdentifier) 過載作為決定使用者角色的首選過載值。

public:
 override bool IsInRole(System::String ^ role);

public:
 virtual bool IsInRole(System::String ^ role);

public override bool IsInRole(string role);

public virtual bool IsInRole(string role);

override this.IsInRole : string -> bool

abstract member IsInRole : string -> bool
override this.IsInRole : string -> bool

Public Overrides Function IsInRole (role As String) As Boolean

Public Overridable Function IsInRole (role As String) As Boolean

參數

傳回

true 若現任負責人是指定Windows使用者群組成員;否則為 false。

實作

範例

以下程式碼範例示範了此 WindowsPrincipal.IsInRole(String) 方法的使用。

字串 BUILTIN\Administrators 和 BUILTIN\Users 用來判斷當前主體是管理員還是使用者。 完整程式碼範例請參見方法。WindowsPrincipal.IsInRole(Int32)

// Get the role using the string value of the role.
Console.WriteLine("{0}? {1}.", "Administrators",
    myPrincipal.IsInRole("BUILTIN\\" + "Administrators"));
Console.WriteLine("{0}? {1}.", "Users",
    myPrincipal.IsInRole("BUILTIN\\" + "Users"));

' Get the role using the string value of the role.
Console.WriteLine("{0}? {1}.", "Administrators", myPrincipal.IsInRole("BUILTIN\" + "Administrators"))
Console.WriteLine("{0}? {1}.", "Users", myPrincipal.IsInRole("BUILTIN\" + "Users"))

備註

在測試新建立的角色資訊（如新使用者或新群組）時，務必登出再登入，以強制角色資訊在網域內傳播。 如果不這麼做，測試可能會 IsInRole 回到 false。

出於效能考量，建議以 IsInRole(SecurityIdentifier) 過載作為決定使用者角色的首選過載值。

對於內建角色，字 role 串應該是「BUILTIN\RoleNameHere」的形式。 例如，為了測試 Windows 管理員角色的成員資格，代表該角色的字串應為「BUILTIN\Administrators」。 請注意，反斜線可能需要跳脫。 下表列出了內建的角色。

對於機器特定角色，字 role 串應該是「MachineName\RoleNameHere」的形式。

對於特定領域的角色，字 role 串應為「DomainName\RoleNameHere」的形式;例如， "SomeDomain\Domain Users「 。

另請參閱

• WindowsBuiltInRole