Changes which server parameters are being watched.

Namespace: ININ.IceLib.Connection.Extensions
Assembly: ININ.IceLib (in ININ.IceLib.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void ChangeWatchedParameters(
	string[] serverParameterNamesToAdd,
	string[] serverParameterNamesToRemove,
	bool replaceExisting
)
Visual Basic
Public Sub ChangeWatchedParameters ( _
	serverParameterNamesToAdd As String(), _
	serverParameterNamesToRemove As String(), _
	replaceExisting As Boolean _
)

Parameters

serverParameterNamesToAdd
Type: array<System..::..String>[]()[][]
The server parameter names to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
serverParameterNamesToRemove
Type: array<System..::..String>[]()[][]
The server parameter names 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: This method silently ignores attempts to add items already being watched or to remove items not being watched.

Note
Accessing this property before a watch is started which includes this property raises a NotCachedException. A watch must be started first. For more information on watches see How Watches Work.
Note
For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
System..::..InvalidOperationExceptionThe object is not being watched.
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
ININ.IceLib..::..NotCachedExceptionThe requested parameter is not in the cache.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

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 3.0, supported for IC Server version 3.0 GA and beyond.

See Also