OPCAE.NET Reference Manual
GetState Method
See Also  Send Feedback
OPCAE.NET Namespace > EventSubscriptionMgt Class : GetState Method

Active
The current active state of the subscription.
BufferTime
The current buffer time configured for event notification. See the discussion in EventSubscriptionMgt.Create
MaxSize
The current max number of events that will be sent in a single OnAEeventHandler callback. See the discussion in EventSubscriptionMgt.Create
ClientSubscription
The client supplied subscription handle.

Glossary Item Box

Get the current state of the subscription.

Syntax

Visual Basic (Declaration) 
Public Function GetState( _
   ByRef Active As Boolean, _
   ByRef BufferTime As Integer, _
   ByRef MaxSize As Integer, _
   ByRef ClientSubscription As Integer _
) As Integer
C# 
public int GetState( 
   out bool Active,
   out int BufferTime,
   out int MaxSize,
   out int ClientSubscription
)

Parameters

Active
The current active state of the subscription.
BufferTime
The current buffer time configured for event notification. See the discussion in EventSubscriptionMgt.Create
MaxSize
The current max number of events that will be sent in a single OnAEeventHandler callback. See the discussion in EventSubscriptionMgt.Create
ClientSubscription
The client supplied subscription handle.

Return Value

HRESULTS error/success code.

Requirements

Target Platforms: Windows 7/8/10, Windows Server 2003/2008/2012/2016, .NET 4.x

See Also

© 2002-2018 Advosol Inc. All Rights Reserved.