'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeEvents( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal sourceDescriptor As AENodeDescriptor, _
   ByVal notificationRate As Integer _
) As Integer

'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim sourceDescriptor As AENodeDescriptor
Dim notificationRate As Integer
Dim value As Integer
 
value = IEasyAEClientExtension.SubscribeEvents(client, serverDescriptor, sourceDescriptor, notificationRate)

[Extension()]
public static int SubscribeEvents( 
   IEasyAEClient client,
   ServerDescriptor serverDescriptor,
   AENodeDescriptor sourceDescriptor,
   int notificationRate
)

[Extension()]
public:
static int SubscribeEvents( 
   IEasyAEClient^ client,
   ServerDescriptor^ serverDescriptor,
   AENodeDescriptor^ sourceDescriptor,
   int notificationRate
) 

Parameters

client

The client object that will perform the operation.

This is typically the EasyAEClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

serverDescriptor

The OPC server involved in the operation.

Because the OpcLabs.EasyOpc.ServerDescriptor has an implicit conversion from System.Guid, System.String and OpcLabs.EasyOpc.ServerElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the server), a string (representing the so-called OPC server descriptor string, such as a ProgID or the URL of the server), or a OpcLabs.EasyOpc.ServerElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC server descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromGuid, FromString or FromServerElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

sourceDescriptor

Event source of interest.

Because the AENodeDescriptor has an implicit conversion from System.String and OpcLabs.EasyOpc.AlarmsAndEvents.AddressSpace.AENodeElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the qualified name of the node), or a OpcLabs.EasyOpc.AlarmsAndEvents.AddressSpace.AENodeElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC A&E node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString or FromAENodeElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

notificationRate

The requested notification rate. The notification rate is in milliseconds and tells the server how often to send event notifications. This is a minimum time - do not send event notifications any faster that this UNLESS the buffer size is reached. A value of 0 for notification rate means that the server should send event notifications as soon as it gets them. This parameter is used to improve communications efficiency between client and server. This parameter is a recommendation from the client, and the server is allowed to ignore the parameter.

Return Value

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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