DANSrvAE Reference
onGetState Method
See Also  Send comments on this topic.
NSPlugin Assembly > NSPlugin Namespace > EventSubscription Class : onGetState Method

_active
The current active state of the subscription.
_bufferTime
The current buffer time configured for event notification. See EventServer::CreateEventSubscription.
_maxSize
The current max number of events that will be sent in a single OnEvent callback. See EventServer::CreateEventSubscription.
_clientSubscription
The client supplied subscription handle

Glossary Item Box

GetState default handler that maybe overloaded by NSPluginAEbase.

Syntax

Visual Basic (Declaration) 
Public Overridable Function onGetState( _
   ByRef _active As Boolean, _
   ByRef _bufferTime As Integer, _
   ByRef _maxSize As Integer, _
   ByRef _clientSubscription As Integer _
) As Integer
C# 
public virtual int onGetState( 
   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 EventServer::CreateEventSubscription.
_maxSize
The current max number of events that will be sent in a single OnEvent callback. See EventServer::CreateEventSubscription.
_clientSubscription
The client supplied subscription handle

Return Value

HResult success/error code

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

© 2004-2017 Advosol Inc. All Rights Reserved.