GenericPrincipal.IsInRole(String) Method

Definition

Determines whether the current GenericPrincipal belongs to the specified role.

C#
public override bool IsInRole(string role);
C#
public override bool IsInRole(string? role);
C#
public virtual bool IsInRole(string role);

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.

Implements

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.

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

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0