GenericPrincipal.IsInRole(String) Method

Definition

Determines whether the current GenericPrincipal belongs to the specified role.

public:
 virtual bool IsInRole(System::String ^ role);
public virtual bool IsInRole (string role);
abstract member IsInRole : string -> bool
override this.IsInRole : string -> bool
Public Overridable Function IsInRole (role As String) As Boolean

Parameters

role
String

The name of the role for which to check membership.

Returns

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

Examples

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( L"NetworkUser" ) )
{
   Console::WriteLine( L"User belongs to the NetworkUser role." );
}
if (genericPrincipal.IsInRole("NetworkUser"))
{
    Console.WriteLine("User belongs to the NetworkUser role.");
}
If (genericPrincipal.IsInRole("NetworkUser")) Then
    WriteLine("User belongs to the NetworkUser role.")
End If

Applies to