This documentation is archived and is not being maintained.

GenericPrincipal.IsInRole Method

Determines whether the current GenericPrincipal belongs to the specified role.

[Visual Basic]
Public Overridable Function IsInRole( _
   ByVal role As String _
) As Boolean Implements IPrincipal.IsInRole
[C#]
public virtual bool IsInRole(
 string role
);
[C++]
public: virtual bool IsInRole(
 String* role
);
[JScript]
public function IsInRole(
   role : String
) : Boolean;

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.

Implements

IPrincipal.IsInRole

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

GenericPrincipal Class | GenericPrincipal Members | System.Security.Principal Namespace

Show: