User::IsInRole Method (BuiltInRole)

.NET Framework (current version)

Determines whether the current user belongs to the specified role.

Namespace: Microsoft.VisualBasic.ApplicationServices
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Syntax

C++

public:
bool IsInRole(
	BuiltInRole role
)

Parameters

role: Type: Microsoft.VisualBasic.ApplicationServices::BuiltInRole
The built-in Windows role for which to check membership.

Return Value

Type: System::Boolean

True if the current user is a member of the specified role; otherwise, False.

Remarks

The My.User.IsInRole method allows your code to determine if the current user is a member of the specified role.

The overload of the My.User.IsInRole method that takes a string provides easy access to the IsInRole method of the current principal.

The overload of the My.User.IsInRole method that takes a BuiltInRole enumeration behaves differently, depending on the current principal. If it is a Windows user principal (WindowsPrincipal), this function converts role to the equivalent WindowsBuiltInRole enumeration and returns the result of calling IsInRole. If the current principal is any other principal, this function passes the name of the enumeration value in role to the principal's IsInRole method.

Note
The exact behavior of the My.User object depends on the type of the application and on the operating system on which the application runs. For more information, see the User class overview.

Availability by Project Type

Project type	Available
Windows Application	Yes
Class Library	Yes
Console Application	Yes
Windows Control Library	Yes
Web Control Library	Yes
Windows Service	Yes
Web Site	Yes

Examples

This example checks if the user is an administrator before accessing a resource.

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

Security

SecurityPermission

Describes a set of security permissions applied to code. Associated enumeration: ControlPrincipal.

Version Information

.NET Framework
Available since 2.0