GenericPrincipal.IsInRole(String) Method

Reference

Definition

Namespace:: System.Security.Principal

Assemblies:: mscorlib.dll, System.Security.Claims.dll

Assembly:: System.Security.Claims.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: GenericPrincipal.cs

Source:: GenericPrincipal.cs

Source:: GenericPrincipal.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines whether the current GenericPrincipal belongs to the specified role.

public:
 override bool IsInRole(System::String ^ role);

public:
 virtual bool IsInRole(System::String ^ role);

public override bool IsInRole (string role);

public override bool IsInRole (string? role);

public virtual bool IsInRole (string role);

override this.IsInRole : string -> bool

abstract member IsInRole : string -> bool
override this.IsInRole : string -> bool

Public Overrides Function IsInRole (role As String) As Boolean

Public Overridable Function IsInRole (role As String) As Boolean

Parameters

role: String

The name of the role for which to check membership.

Returns

Boolean

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

Implements

IsInRole(String)

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

Jaa