Asynchronously logs out user from all the applications.

Note: This method is supported for IC Server version 2017 R3 and beyond.

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

Syntax

C#
public void ForceUserLogoutAsync(
	string userId,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub ForceUserLogoutAsync ( _
	userId As String, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

userId
Type: System..::..String
User ID to be forced logout.
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

An appropriate IceLibException will be thrown if the is user not logged out.

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.

Version Information

Supported for IC Server version 2017 R3 and beyond.

See Also