WindowsPrincipal.IsInRole

.NET Framework クラス ライブラリ リファレンス

WindowsPrincipal.IsInRole メソッド (WindowsBuiltInRole)

現在のプリンシパルが、指定した WindowsBuiltInRole の Windows ユーザー グループに属しているかどうかを確認します。

名前空間: System.Security.Principal
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 IsInRole ( _
    role As WindowsBuiltInRole _
) As Boolean

Visual Basic (使用法)

Dim instance As WindowsPrincipal
Dim role As WindowsBuiltInRole
Dim returnValue As Boolean

returnValue = instance.IsInRole(role)

C#

public virtual bool IsInRole (
    WindowsBuiltInRole role
)

C++

public:
virtual bool IsInRole (
    WindowsBuiltInRole role
)

J#

public boolean IsInRole (
    WindowsBuiltInRole role
)

JScript

public function IsInRole (
    role : WindowsBuiltInRole
) : boolean

パラメータ

role

WindowsBuiltInRole 値の 1 つ。

戻り値
現在のプリンシパルが、指定した Windows ユーザー グループのメンバである場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentException	role が有効な WindowsBuiltInRole 値ではありません。

解説

新しいユーザーや新しいグループなど、新しく作成されたロール情報をテストする場合は、ドメイン内でのロール情報の反映を強制するために、ログアウトとログインを行うことが重要です。これを行わない場合、IsInRole テストを実行すると false が返されることがあります。

メモ
パフォーマンス上の理由から、ユーザーのロールを決定するのに適したオーバーロードとして、IsInRole(SecurityIdentifier) オーバーロードをお勧めします。

重要 :
IsInRole メソッドは、Windows 98 および Windows Millennium Edition では結果を返しません。

プラットフォーム

Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WindowsPrincipal クラス
WindowsPrincipal メンバ
System.Security.Principal 名前空間

WindowsPrincipal.IsInRole メソッド (Int32)

現在のプリンシパルが、指定した相対識別子 (RID) の Windows ユーザー グループに属しているかどうかを確認します。

名前空間: System.Security.Principal
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 IsInRole ( _
    rid As Integer _
) As Boolean

Visual Basic (使用法)

Dim instance As WindowsPrincipal
Dim rid As Integer
Dim returnValue As Boolean

returnValue = instance.IsInRole(rid)

C#

public virtual bool IsInRole (
    int rid
)

C++

public:
virtual bool IsInRole (
    int rid
)

J#

public boolean IsInRole (
    int rid
)

JScript

public function IsInRole (
    rid : int
) : boolean

パラメータ

rid

プリンシパルのメンバシップ状態を確認する Windows ユーザー グループの RID。

戻り値
現在のプリンシパルが、指定した Windows ユーザー グループのメンバである、つまり特定のロール内にある場合は true。それ以外の場合は false。

解説

新しいユーザーや新しいグループなど、新しく作成されたロール情報をテストする場合は、ドメイン内でのロール情報の反映を強制するために、ログアウトとログインを行うことが重要です。これを行わない場合、IsInRole テストを実行すると false が返されることがあります。

メモ
パフォーマンス上の理由から、ユーザーのロールを決定するのに適したオーバーロードとして、IsInRole(SecurityIdentifier) オーバーロードをお勧めします。

重要 :
IsInRole メソッドは、Windows 98 および Windows Millennium Edition では結果を返しません。

相対識別子 (RID) は、Windows ユーザー グループのセキュリティ識別子 (SID) のコンポーネントであり、プラットフォーム間のローカリゼーション問題を回避するためにサポートされています。多数のユーザー アカウント、ローカル グループ、およびグローバル グループは、Windows のすべてのバージョンで一定である既定の RID 値を持っています。

たとえば、BUILTIN\Administrators ロールの RID は 0x220 です。0x220 を IsInRole メソッドの入力パラメータとして使用すると、現在のプリンシパルが管理者である場合に true が返されます。

次の表に、既定の RID 値を示します。

組み込みユーザー	RID
DOMAINNAME\Administrator	0x1F4
DOMAINNAME\Guest	0x1F5

組み込みグローバル グループ	RID
DOMAINNAME\Domain Admins	0x200
DOMAINNAME\Domain Users	0x201
DOMAINNAME\Domain Guests	0x202

組み込みローカル グループ	RID
BUILTIN\Administrators	0x220
BUILTIN\Users	0x221
BUILTIN\Guests	0x222
BUILTIN\Account Operators	0x224
BUILTIN\Server Operators	0x225
BUILTIN\Print Operators	0x226
BUILTIN\Backup Operators	0x227
BUILTIN\Replicator	0x228

プラットフォーム

Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WindowsPrincipal クラス
WindowsPrincipal メンバ
System.Security.Principal 名前空間

WindowsPrincipal.IsInRole メソッド (String)

現在のプリンシパルが、指定した名前の Windows ユーザー グループに属しているかどうかを確認します。

名前空間: System.Security.Principal
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 IsInRole ( _
    role As String _
) As Boolean

Visual Basic (使用法)

Dim instance As WindowsPrincipal
Dim role As String
Dim returnValue As Boolean

returnValue = instance.IsInRole(role)

C#

public virtual bool IsInRole (
    string role
)

C++

public:
virtual bool IsInRole (
    String^ role
)

J#

public boolean IsInRole (
    String role
)

JScript

public function IsInRole (
    role : String
) : boolean

パラメータ

role

メンバシップを確認する対象の Windows ユーザー グループの名前。

戻り値
現在のプリンシパルが、指定した Windows ユーザー グループのメンバである場合は true。それ以外の場合は false。

解説

新しいユーザーや新しいグループなど、新しく作成されたロール情報をテストする場合は、ドメイン内でのロール情報の反映を強制するために、ログアウトとログインを行うことが重要です。これを行わない場合、IsInRole テストを実行すると false が返されることがあります。

メモ
パフォーマンス上の理由から、ユーザーのロールを決定するのに適したオーバーロードとして、IsInRole(SecurityIdentifier) オーバーロードをお勧めします。

重要 :
IsInRole メソッドは、Windows 98 および Windows Millennium Edition では結果を返しません。

組み込みのロールの場合は、role 文字列を "BUILTIN\RoleNameHere" の形式にする必要があります。たとえば、Windows の管理者ロールのメンバシップを調べるには、ロールを表す文字列を "BUILTIN\Administrators" にする必要があります。円記号は、必要に応じてエスケープします。

コンピュータ固有のロールの場合は、role 文字列を "MACHINENAME\RoleNameHere" の形式にする必要があります。

メモ
コンピュータ名ではなくドメイン名によるロールの修飾は無効です。ロールは、現在のプリンシパルのドメインに対してのみ決定できます。

メモ
.NET Framework Version 1.0 の場合、role パラメータでは大文字と小文字が区別されます。.NET Framework Version 1.1 以降の場合、role パラメータでは大文字と小文字が区別されません。

使用例

組み込みのロールを表す文字列を使用して、IsInRole を呼び出す方法を次の例に示します。

Visual Basic

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

         Console.WriteLine("{0}? {1}.", roleName,
 _
                           myPrincipal.IsInRole(CType(roleName, WindowsBuiltInRole)))

      Catch

     Console.WriteLine("{0}: Could not obtain the role for this
 RID.", roleName)

      End Try
   Next roleName

End Sub 'DemonstrateWindowsBuiltInRoleEnum

C#

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
        {
            Console.WriteLine("{0}? {1}.", roleName,
                myPrincipal.IsInRole((WindowsBuiltInRole)roleName));
        } 
        catch (Exception)
        {
            Console.WriteLine("{0}: Could not obtain role for
 this RID.",
                roleName);
        }
    }        

}

C++

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 );
         }
      }
   }

J#

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

    myDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal);

    WindowsPrincipal myPrincipal = ((WindowsPrincipal)
        (Thread.get_CurrentPrincipal()));

    Console.WriteLine("{0} belongs to: ",
        myPrincipal.get_Identity().get_Name().ToString());

    Array wbirFields = Enum.GetValues(WindowsBuiltInRole.class.ToType());

    for (int iCtr = 0; iCtr < wbirFields.get_Count();
 iCtr++) {
        Object roleName = wbirFields.get_Item(iCtr);
        try {
            Console.WriteLine("{0}? {1}.", roleName, 
            System.Convert.ToString(myPrincipal.
            IsInRole(((WindowsBuiltInRole)(roleName)))));
        }
        catch (System.Exception exp) {
            Console.WriteLine(
                "{0}: Could not obtain role for this
 RID.", roleName);
        }
    }
} //DemonstrateWindowsBuiltInRoleEnum

プラットフォーム

Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WindowsPrincipal クラス
WindowsPrincipal メンバ
System.Security.Principal 名前空間

WindowsPrincipal.IsInRole メソッド

現在のプリンシパルが、指定した Windows ユーザー グループに属しているかどうかを確認します。
オーバーロードの一覧

名前	説明
WindowsPrincipal.IsInRole (Int32)	現在のプリンシパルが、指定した相対識別子 (RID) の Windows ユーザー グループに属しているかどうかを確認します。
WindowsPrincipal.IsInRole (SecurityIdentifier)	現在のプリンシパルが、指定したセキュリティ識別子 (SID) で Windows ユーザー グループに属しているかどうかを確認します。
WindowsPrincipal.IsInRole (String)	現在のプリンシパルが、指定した名前の Windows ユーザー グループに属しているかどうかを確認します。
WindowsPrincipal.IsInRole (WindowsBuiltInRole)	現在のプリンシパルが、指定した WindowsBuiltInRole の Windows ユーザー グループに属しているかどうかを確認します。

参照

関連項目

WindowsPrincipal クラス
WindowsPrincipal メンバ
System.Security.Principal 名前空間

WindowsPrincipal.IsInRole メソッド (SecurityIdentifier)

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

現在のプリンシパルが、指定したセキュリティ識別子 (SID) で Windows ユーザー グループに属しているかどうかを確認します。

名前空間: System.Security.Principal
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(False)> _
Public Overridable Function
 IsInRole ( _
    sid As SecurityIdentifier _
) As Boolean

Visual Basic (使用法)

Dim instance As WindowsPrincipal
Dim sid As SecurityIdentifier
Dim returnValue As Boolean

returnValue = instance.IsInRole(sid)

C#

[ComVisibleAttribute(false)] 
public virtual bool IsInRole (
    SecurityIdentifier sid
)

C++

[ComVisibleAttribute(false)] 
public:
virtual bool IsInRole (
    SecurityIdentifier^ sid
)

J#

/** @attribute ComVisibleAttribute(false) */ 
public boolean IsInRole (
    SecurityIdentifier sid
)

JScript

ComVisibleAttribute(false) 
public function IsInRole (
    sid : SecurityIdentifier
) : boolean

パラメータ

sid

SecurityIdentifier は、Windows ユーザー グループを一意に識別します。

戻り値
現在のプリンシパルが、指定した Windows ユーザー グループのメンバである場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	sid が null 参照 (Visual Basic では Nothing) です。
SecurityException	Windows は Win32 エラーを返します。

解説

SecurityIdentifier は、Windows 2000、Windows Server、および Windows XP 実装でユーザーまたはグループを一意に識別します。

重要 :
IsInRole メソッドは、Windows 98 および Windows Millennium Edition では結果を返しません。

新しいユーザーや新しいグループなど、新しく作成されたロール情報をテストする場合は、ドメイン内でのロール情報の反映を強制するために、ログアウトとログインを行うことが重要です。これを行わない場合、IsInRole テストを実行すると false が返されることがあります。

パフォーマンス上の理由から、これはユーザーのロールを決定するために推奨されるオーバーロードです。

プラットフォーム

Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WindowsPrincipal クラス
WindowsPrincipal メンバ
System.Security.Principal 名前空間