PullMultipleNotifications Method (IEasyAEClient)

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

Syntax

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As IEasyAEClient
Dim maximumCount As Integer
Dim millisecondsTimeout As Integer
Dim value() As EasyAENotificationEventArgs
 
value = instance.PullMultipleNotifications(maximumCount, millisecondsTimeout)

[CanBeNull()]
[EditorBrowsable(EditorBrowsableState.Advanced)]
EasyAENotificationEventArgs[] PullMultipleNotifications( 
   int maximumCount,
   int millisecondsTimeout
)

[CanBeNull()]
[EditorBrowsable(EditorBrowsableState.Advanced)]
array<EasyAENotificationEventArgs^>^ PullMultipleNotifications( 
   int maximumCount,
   int 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).

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

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

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