Specifies constants indicating the reason for the state of a Session's connection.

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

Syntax

C#
public enum ConnectionStateReason
Visual Basic
Public Enumeration ConnectionStateReason

Members

Member nameValueDescription
None0There is no reason for the current connection state.
ServerNotResponding1The connection state is not up because the server is not responding.
LogOn2The connection state is attempting or up because a logon has been initiated.
LogOnFailed3The connection state is down because the logon attempt failed.
AdminLogOff4The connection state is down due to administrative action.
UserDeleted5The connection state is down due to administrative action.
StationDeleted6The connection state is down due to administrative action.
StationDeactivated7The connection state is down due to administrative action.
AnotherLogOn8The connection state is down due to a subsequent logon.
UserLogOff9The connection state is down because the user has logged off.
SessionTimeout10The connection state is down because the session has timed out.
Switchover11The connection state is down because a switchover has been initiated.

Remarks

This enumeration is used to indicate the reason for the Session's ConnectionState.

Examples

The following example demonstrates usage of a Session object.
CopyC#
using ININ.IceLib.Connection;

Session session = new Session();

... // Further processing

if ((session.ConnectionState == ConnectionState.Down) && (session.ConnectionStateReason == ConnectionStateReason.LogOnFailed))
{
  // The login attempt failed.
}

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