A synchronous request to query and watch statistic values at the given keys.
Namespace: ININ.IceLib.Statistics
Assembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
| C# |
|---|
public void StartWatching( StatisticKey[] keysToWatch ) |
| Visual Basic |
|---|
Public Sub StartWatching ( _ keysToWatch As StatisticKey() _ ) |
Parameters
- keysToWatch
- Type: array<ININ.IceLib.Statistics..::..StatisticKey>[]()[][]
The keys for the statistic values to start watching.
Remarks
 Note |
|---|
| All event handlers should be added before calling StartWatching(array<StatisticKey>[]()[][]) or StartWatchingAsync(array<StatisticKey>[]()[][], AsyncCompletedEventHandler, Object). |
| Note |
|---|
| For more information on watches see How Watches Work. |
| Note |
|---|
| Any requests for a statistic that has not yet been added to the cache from any session will initially return the value of 'N/A'. It will then be updated via StatisticValueUpdated when the cache is updated with the actual value. |
Exceptions
| Exception | Condition |
|---|---|
| System..::..ArgumentNullException | keysToWatch is nullNothingnullptra null reference (Nothing in Visual Basic). |
| System..::..ArgumentException | keysToWatch is empty. |
| System..::..InvalidOperationException | This StatisticListener is already watched. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
