GetIsInRoleObservable Method

Gets an observable that indicates whether the principal is in the specified security role.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Function GetIsInRoleObservable( _
   ByVal securityRole As ISecurityRole _
) As IObservable(Of Boolean)

'Usage
 
Dim instance As ISecurityPrincipal
Dim securityRole As ISecurityRole
Dim value As IObservable(Of Boolean)
 
value = instance.GetIsInRoleObservable(securityRole)

[JetBrains.Annotations.NotNull()]
IObservable<bool> GetIsInRoleObservable( 
   ISecurityRole securityRole
)

[JetBrains.Annotations.NotNull()]
IObservable<bool>^ GetIsInRoleObservable( 
   ISecurityRole^ securityRole
)

Parameters

securityRole: The security role to check.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

An observable that emits true when the principal is in the role; otherwise, false.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

The observables are never completed, and they are never removed from the security principal. This is by design. It is expected that the observables will be used for the lifetime of the security principal anyway.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

ISecurityPrincipal Interface
ISecurityPrincipal Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.