PullMultipleNotifications Method (

Attempts to pull multiple OPC events subscribed to by the OpcLabs.EasyOpc.AlarmsAndEvents.IEasyAEClient.SubscribeEvents method. Returns refresh or standard event notifications.

Syntax

[JetBrains.Annotations.CanBeNull()]
[EditorBrowsable(EditorBrowsableState.Advanced)]
[JetBrains.Annotations.ItemNotNull()]
object[] PullMultipleNotifications( 
   int maximumCount,
   int millisecondsTimeout
)

[JetBrains.Annotations.CanBeNull()]
[EditorBrowsable(EditorBrowsableState.Advanced)]
[JetBrains.Annotations.ItemNotNull()]
array<Object^>^ PullMultipleNotifications( 
   int maximumCount,
   int millisecondsTimeout
)

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
<EditorBrowsableAttribute(EditorBrowsableState.Advanced)>
<JetBrains.Annotations.ItemNotNullAttribute()>
Function PullMultipleNotifications( _
   ByVal maximumCount As Integer, _
   ByVal millisecondsTimeout As Integer _
) As Object()

'Usage
 
Dim instance As _EasyAEClient
Dim maximumCount As Integer
Dim millisecondsTimeout As Integer
Dim value() As Object
 
value = instance.PullMultipleNotifications(maximumCount, millisecondsTimeout)

Parameters

maximumCount: Maximum number of event notifications returned.
millisecondsTimeout: The number of milliseconds to wait, or System.Threading.Timeout.Infinite (-1) to wait indefinitely.

Return Value

An array of event arguments, or null if no event is available within the specified time.

This method can return null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

This return value of this method should not be ignored.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.ObjectDisposedException	An operation was performed on a disposed object.

Exception

Description

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

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.ObjectDisposedException

An operation was performed on a disposed object.

Remarks

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

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