uaPLUS Reference
SetState Method
See Also  Send Feedback
NSPlugin Namespace > EventSubscription Class : SetState Method

active
TRUE (non-zero) to activate the subscription. FALSE (0) to deactivate the subscription. If the client deactivates the subscription, then the server will no longer send event notifications to the client based on that subscription, and has no responsibility to buffer or maintain the event notifications. Thus event notifications may be lost. Even if the subscription is inactive, the Refresh method will still function. In effect, this allows a client to obtain current condition states from time to time (by invoking Refresh) without the need to process event notifications in “real time”.
activeDefined
Must be TRUE for the 'active' property argument to be processed.
_bufferTime
bufferTimeDefined
Must be TRUE for the 'bufferTime' property argument to be processed.
_maxSize
maxSizeDefined
Must be TRUE for the 'maxSize' property argument to be processed.
_clientSubscription
revisedBufferTime
The buffer time that the server is actually providing, which may differ from bufferTime.
revisedMaxSize
The maximum number of events that the server will actually be sending in a single OnEvent callback, which may differ from dwMaxSize.

Glossary Item Box

Client can set various properties of the event subscription. Only properties with the xxxDefined flag = TRUE are processed.

Syntax

Visual Basic (Declaration) 
Public Function SetState( _
   ByVal active As Boolean, _
   ByVal activeDefined As Boolean, _
   ByVal _bufferTime As Integer, _
   ByVal bufferTimeDefined As Boolean, _
   ByVal _maxSize As Integer, _
   ByVal maxSizeDefined As Boolean, _
   ByVal _clientSubscription As Integer, _
   ByRef revisedBufferTime As Integer, _
   ByRef revisedMaxSize As Integer _
) As Integer
C# 
public int SetState( 
   bool active,
   bool activeDefined,
   int _bufferTime,
   bool bufferTimeDefined,
   int _maxSize,
   bool maxSizeDefined,
   int _clientSubscription,
   out int revisedBufferTime,
   out int revisedMaxSize
)

Parameters

active
TRUE (non-zero) to activate the subscription. FALSE (0) to deactivate the subscription. If the client deactivates the subscription, then the server will no longer send event notifications to the client based on that subscription, and has no responsibility to buffer or maintain the event notifications. Thus event notifications may be lost. Even if the subscription is inactive, the Refresh method will still function. In effect, this allows a client to obtain current condition states from time to time (by invoking Refresh) without the need to process event notifications in “real time”.
activeDefined
Must be TRUE for the 'active' property argument to be processed.
_bufferTime
bufferTimeDefined
Must be TRUE for the 'bufferTime' property argument to be processed.
_maxSize
maxSizeDefined
Must be TRUE for the 'maxSize' property argument to be processed.
_clientSubscription
revisedBufferTime
The buffer time that the server is actually providing, which may differ from bufferTime.
revisedMaxSize
The maximum number of events that the server will actually be sending in a single OnEvent callback, which may differ from dwMaxSize.

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.