Starts an asynchronous 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 ChangeWatchedKeysAsync(
	StatisticKey[] keysToAdd,
	StatisticKey[] keysToRemove,
	bool replaceExisting,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub ChangeWatchedKeysAsync ( _
	keysToAdd As StatisticKey(), _
	keysToRemove As StatisticKey(), _
	replaceExisting As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

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.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

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