Asynchronously changes the list of users, stations, and computers to watch for user login/logout events.

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 ChangeWatchedSessionsAsync(
	SessionWatchId[] sessionWatchIdsToAdd,
	SessionWatchId[] sessionWatchIdsToRemove,
	bool replaceExisting,
	EventHandler<SessionWatchAsyncEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub ChangeWatchedSessionsAsync ( _
	sessionWatchIdsToAdd As SessionWatchId(), _
	sessionWatchIdsToRemove As SessionWatchId(), _
	replaceExisting As Boolean, _
	completedCallback As EventHandler(Of SessionWatchAsyncEventArgs), _
	userState As Object _
)

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.
completedCallback
Type: System..::..EventHandler<(Of <(<'SessionWatchAsyncEventArgs>)>)>
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.

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

ExceptionCondition
System..::..ArgumentNullExceptionAn element in a parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

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.

See Also