'Declaration
<ExtensionAttribute()> Public Overloads Shared Function SubscribeEvents( _ ByVal client As IEasyAEClient, _ ByVal machineName As String, _ ByVal serverClass As String, _ ByVal notificationRate As Integer, _ ByVal state As Object, _ ByVal filter As AESubscriptionFilter _ ) As Integer
'Usage
Dim client As IEasyAEClient Dim machineName As String Dim serverClass As String Dim notificationRate As Integer Dim state As Object Dim filter As AESubscriptionFilter Dim value As Integer value = IEasyAEClientExtension.SubscribeEvents(client, machineName, serverClass, notificationRate, state, filter)
[Extension()] public static int SubscribeEvents( IEasyAEClient client, string machineName, string serverClass, int notificationRate, object state, AESubscriptionFilter filter )
[Extension()] public: static int SubscribeEvents( IEasyAEClient^ client, String^ machineName, String^ serverClass, int notificationRate, Object^ state, AESubscriptionFilter^ filter )
Parameters
- client
- The client object that will perform the operation.
- machineName
- Name of the machine. Determines the computer on which the OPC server is located. May be an empty string, in which case the OPC server is assumed to exist on the local computer or at the computer specified for it by DCOM configuration.
- serverClass
- Contains ProgID of the OPC server.
- 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.
- state
- The state object (can be any value supplied by your code); available in event notifications.
- filter
- An AESubscriptionFilter that determines the filtering criteria to be used for the event subscription.
Return Value
The method returns an integer handle that uniquely identifies the event subscription.