My.User.IsInRole 方法

更新：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 服务	可用
网站	可用

权限

可能需要下列权限：

权限	说明
SecurityPermission	描述应用于代码的一组安全权限。关联的枚举：ControlPrincipal。

有关更多信息，请参见代码访问安全性和请求权限。

请参见

任务

如何：确定用户是否属于某个组

演练：实现自定义身份验证和授权

参考

My.User 对象

BuiltInRole 枚举

Microsoft.VisualBasic.ApplicationServices.BuiltInRole

User.IsInRole