My.User.IsInRole メソッド

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

現在のユーザーが指定のロールに所属しているかどうかを調べます。

' Usage
Dim value As Boolean = My.User.IsInRole(role)
Dim value As Boolean = My.User.IsInRole(role)
' Declaration
Public Function IsInRole( _
   ByVal role As String _
) As Boolean
' -or-
Public Function IsInRole( _
   ByVal role As BuiltInRole _
) As Boolean

パラメータ

role
String または BuiltInRole 列挙型。メンバシップを調べるロールを指定します。

戻り値

現在のユーザーが指定のロールのメンバである場合は True、それ以外の場合は False を返します。

解説

My.User.IsInRole メソッドを使用すると、現在のユーザーが指定のロールのメンバであるかどうかをコードで確認できます。

文字列を受け取る My.User.IsInRole メソッドのオーバーロードを使用すると、現在のプリンシパルの IsInRole メソッドに簡単にアクセスできます。

BuiltInRole 列挙体を受け取る My.User.IsInRole メソッドのオーバーロードは、現在のプリンシパルに応じて異なる動作をします。現在のプリンシパルが Windows ユーザープリンシパル (WindowsPrincipal) の場合は、この関数は role を等価の WindowsBuiltInRole 列挙体に変換し、IsInRole を呼び出した結果を返します。現在のプリンシパルがそれ以外のプリンシパルである場合は、この関数は、role 内の列挙値の名前をそのプリンシパルの IsInRole メソッドに渡します。

メモ :
My.User オブジェクトの厳密な動作は、アプリケーションの種類と、そのアプリケーションを実行するオペレーティングシステムによって左右されます。詳細については、「My.User オブジェクト」を参照してください。

処理手順

目的	参照項目
ユーザーのロールを確認する	方法 : ユーザーがグループに属しているかどうかを確認する

使用例

この例では、リソースにアクセスする前に、ユーザーが管理者かどうかを調べます。

If My.User.IsInRole( _
        ApplicationServices.BuiltInRole.Administrator) Then
    ' Insert code to access a resource here.
End If

必要条件

名前空間 : Microsoft.VisualBasic.ApplicationServices

クラス : User、WebUser

アセンブリ : Visual Basic ランタイムライブラリ (Microsoft.VisualBasic.dll 内)

プロジェクトの種類ごとの可用性

プロジェクトの種類	可用性
Windows アプリケーション	可
クラスライブラリ	可
コンソールアプリケーション	可
Windows コントロールライブラリ	可
Web コントロールライブラリ	可
Windows サービス	可
Web サイト	可

アクセス許可

次のアクセス許可が必要になる場合があります。

アクセス許可	説明
SecurityPermission	コードに適用される一連のセキュリティアクセス許可を表します。関連する列挙値 : ControlPrincipal。