Changes the list of users, stations, and computers to watch for user login/logout events.
Namespace: ININ.IceLib.Connection.ExtensionsAssembly: ININ.IceLib (in ININ.IceLib.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public ReadOnlyCollection<SessionWatchSettings> ChangeWatchedSessions( SessionWatchId[] sessionWatchIdsToAdd, SessionWatchId[] sessionWatchIdsToRemove, bool replaceExisting ) |
Visual Basic |
---|
Public Function ChangeWatchedSessions ( _ sessionWatchIdsToAdd As SessionWatchId(), _ sessionWatchIdsToRemove As SessionWatchId(), _ replaceExisting As Boolean _ ) As ReadOnlyCollection(Of SessionWatchSettings) |
Parameters
- sessionWatchIdsToAdd
- Type: array<ININ.IceLib.Connection.Extensions..::..SessionWatchId>[]()[][]
The session watch IDs to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
- sessionWatchIdsToRemove
- Type: array<ININ.IceLib.Connection.Extensions..::..SessionWatchId>[]()[][]
The session watch IDs 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.
Return Value
The session watch settings.Remarks
This method silently ignores attempts to add items already being watched or to remove items not being watched.
Note |
---|
For more information on watches see How Watches Work. |
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | An element in a parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..InvalidOperationException | The object is not being watched. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The 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.
For 2.4, supported for IC Server version 2.4 SU 27 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.
For 2.4, supported for IC Server version 2.4 SU 27 and beyond.