GenericPrincipal.IsInRole Method

Determines whether the current GenericPrincipal belongs to the specified role.

Namespace: System.Security.Principal
Assembly: mscorlib (in mscorlib.dll)

'Declaration
Public Overridable Function IsInRole ( _
	role As String _
) As Boolean
'Usage
Dim instance As GenericPrincipal
Dim role As String
Dim returnValue As Boolean

returnValue = instance.IsInRole(role)
public boolean IsInRole (
	String role
)
public function IsInRole (
	role : String
) : boolean
Not applicable.

Parameters

role

The name of the role for which to check membership.

Return Value

true if the current GenericPrincipal is a member of the specified role; otherwise, false.

The following code shows the use of the IsInRole method. This code example is part of a larger example provided for the GenericPrincipal class.

If (genericPrincipal.IsInRole("NetworkUser")) Then
    WriteLine("User belongs to the NetworkUser role.")
End If

if (genericPrincipal.IsInRole("NetworkUser")) {
    Console.WriteLine("User belongs to the NetworkUser role.");
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: