Asynchronously sets the station connection mode for the session, which controls when the user is logged out of the station.

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

Syntax

C#
public void SetStationConnectionModeAsync(
	StationConnectionMode stationConnectionMode,
	int applicationGroupId,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub SetStationConnectionModeAsync ( _
	stationConnectionMode As StationConnectionMode, _
	applicationGroupId As Integer, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

stationConnectionMode
Type: ININ.IceLib.Connection..::..StationConnectionMode
The station connection mode.
applicationGroupId
Type: System..::..Int32
The application group ID.
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

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.

SetStationConnectionModeAsync behavior has changed as of 3.0 SU 19 and 4.0 SU 5. This method should still be invoked to preserve backwards compatibility with older 3.0/4.0 SUs; however, to utilize the new station login persistence model, a new property should be set on the appropriate StationSettings-derived class: PersistStationLogin, PersistStationLogin, and PersistStationLogin. Additionally, a new Disconnect(Boolean) method has been added to allow specifying the expected behavior of the persisted station login when disconnecting a session.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
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