IPrincipal.IsInRole Method (System.Security.Principal)

.NET Framework Class Library

IPrincipal..::.IsInRole Method

Determines whether the current principal belongs to the specified role.

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

Syntax

Visual Basic (Declaration)

Function IsInRole ( _
    role As String _
) As Boolean

Visual Basic (Usage)

Dim instance As IPrincipal
Dim role As String
Dim returnValue As Boolean

returnValue = instance.IsInRole(role)

bool IsInRole(
    string role
)

Visual C++

bool IsInRole(
    String^ role
)

JScript

function IsInRole(
    role : String
) : boolean

Parameters

role: Type: System..::.String
The name of the role for which to check membership.

Return Value

Type: System..::.Boolean
true if the current principal is a member of the specified role; otherwise, false.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

IPrincipal Interface

IPrincipal Members

System.Security.Principal Namespace