IsKnownItemSubscriptionHandle Method (IEasyDAClient)

Determines whether the given item subscription handle is known to this client.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.PureAttribute()>
Function IsKnownItemSubscriptionHandle( _
   ByVal handle As Integer _
) As Boolean

'Usage
 
Dim instance As IEasyDAClient
Dim handle As Integer
Dim value As Boolean
 
value = instance.IsKnownItemSubscriptionHandle(handle)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
bool IsKnownItemSubscriptionHandle( 
   int handle
)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
bool IsKnownItemSubscriptionHandle( 
   int handle
)

Parameters

handle: The item subscription handle to be tested.

Return Value

Returns true if the given handle is known to the client (i.e. represents a currently subscribed item). Otherwise, returns false.

This return value of this method should not be ignored.

Exceptions

Exception	Description
System.ObjectDisposedException	An operation was performed on a disposed object.

Remarks

This method is pure, i.e. it does not have observable side effects.

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

IEasyDAClient Interface
IEasyDAClient 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.