A synchronous request to change the watched statistic values.

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 ChangeWatchedKeys(
	StatisticKey[] keysToAdd,
	StatisticKey[] keysToRemove,
	bool replaceExisting
)
Visual Basic
Public Sub ChangeWatchedKeys ( _
	keysToAdd As StatisticKey(), _
	keysToRemove As StatisticKey(), _
	replaceExisting As Boolean _
)

Parameters

keysToAdd
Type: array<ININ.IceLib.Statistics..::..StatisticKey>[]()[][]
The keys of the statistic values to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
keysToRemove
Type: array<ININ.IceLib.Statistics..::..StatisticKey>[]()[][]
The keys of the statistic values to remove. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
replaceExisting
Type: System..::..Boolean
if set to trueTruetruetrue (True in Visual Basic), replace the existing list.

Remarks

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

ExceptionCondition
System..::..InvalidOperationExceptionThis StatisticListener is not watched.
System..::..ArgumentNullExceptionThe keysToAdd or keysToRemove collection contains a nullNothingnullptra null reference (Nothing in Visual Basic) item.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.

See Also