This function is typically called to obtain the current values of this information prior to calling SetState. This information was all supplied by the client when the subscription was created. This function is also useful for debugging.
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 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 codeRequirements
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family