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.1.0.214)

Syntax

C#
public void SetStationConnectionMode(
	StationConnectionMode stationConnectionMode,
	int applicationGroupId
)
Visual Basic
Public Sub SetStationConnectionMode ( _
	stationConnectionMode As StationConnectionMode, _
	applicationGroupId As Integer _
)

Parameters

stationConnectionMode
Type: ININ.IceLib.Connection..::..StationConnectionMode
The station connection mode.
applicationGroupId
Type: System..::..Int32
The application group ID.

Remarks

The StationConnectionMode controls whether the user remains connected to the station, or is logged out of the station when the IceLib session is disconnected. See the documentation for StationConnectionMode for a description of each mode.

For cases where the station connection remains after the IceLib Session disconnects, the applicationGroupId is used to group the station connections made by the specific client application so that the application can manage them from subsequent IceLib sessions.

SetStationConnectionMode 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.

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