Asynchronously disconnects the Session.

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

Syntax

C#
public void DisconnectAsync(
	bool persistStationLogin,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub DisconnectAsync ( _
	persistStationLogin As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

persistStationLogin
Type: System..::..Boolean
trueTruetruetrue (True in Visual Basic) if the station login is persisted; otherwise, falseFalsefalsefalse (False in Visual Basic).
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An object that contains state information for this request.

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.

Exceptions

ExceptionCondition
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 SU 5 and beyond.
For 3.0, supported for IC Server version 3.0 SU 19 and beyond.

See Also