General class library reference

Below is a summary of all the General Class Library References available for .NET in HostFront 5.0

Table 1: HostFront .NET general class library

Class name	Associated methods	Associated properties
AccountInfo		ConnectedDisplays ConnectedFTs ConnectedPrinters MaxDisplays MaxFTs MaxPrinters
ClusterHFServiceInfo		DisplaySessions EmulationType FileTransferSessions IPAddress PrinterSessions TotalSessions
ClusterInfo		ActiveSessions ActiveUsers Servers
QueryHost	GetAccountInfo(String,String) GetAccountInfo(System.Uri,String) GetClusterInfo(System.Uri) GetServerInfo(String) GetSessionStatus(String,System...) GetSessionStatus(String,System.Uri) GetSessionStatusHFEE(String,System...) GetSessionStatusHFEE(String,System.Uri)
ConnectionInfo		DataStream DeviceName HostName LUName Port
ScreenField	ToString	AlphaNumeric AlphaOnly AutoEnter Blinking Column DigitOnly FieldExit Highlighted IsModified MandatoryEnter MaxLength NumericOnly Protected ReadOnly Row SignedNumeric TextColor Underlined UpperCase Value
ScreenFields	GetEnumerator	Count Indexer
ScreenIdentifier	ScreenIdentifier(System.String...) ScreenIdentifier(String,System...)	ColumnEnd columnStart FieldValue Row
ServerInfo		ActiveSessions ActiveUsers Sessions Users
SessionInfo		Busy HostFrontServerAddress KeyboardLocked Message
SessionInfoHFEE		Busy CnxTimeBusy DeviceName EmulationType HostFrontServerAddress HostName KeyboardLocked Message SessionName SessionType UserIPAddress

AccountInfo class

This class retrieves specific account information created in HostFront Server, and it is used only with Versions prior to 3.6.x.

Prototype

public sealed struct AccountInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the AccountInfo class.

ConnectedDisplays

The number of connected display sessions for a given user account.

Prototype

public System.Int32 ConnectedDisplays

Member of HostFront.EAI.AccountInfo

ConnectedFTs

The number of connected file transfer sessions for a given user account.

Prototype

public System.Int32 ConnectedFTs

Member of HostFront.EAI.AccountInfo

ConnectedPrinters

The number of connected printer sessions for a given user account.

Prototype

public System.Int32 ConnectedPrinters

Member of HostFront.EAI.AccountInfo

MaxDisplays

The maximum number of display sessions for a given user account.

Prototype

public System.Int32 MaxDisplays

Member of HostFront.EAI.AccountInfo

MaxFTs

The maximum number of file transfer sessions for a given user account.

Prototype

public System.Int32 MaxFTs

Member of HostFront.EAI.AccountInfo

MaxPrinters

The maximum number of printer sessions for a given user account.

Prototype

public System.Int32 MaxPrinters

Member of HostFront.EAI.AccountInfo

ClusterHFServiceInfo class

This structure describes a running HostFront service and is used in the ClusterInfo structure.

Prototype

public sealed struct ClusterHFServiceInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the ClusterHFServiceInfo class.

DisplaySessions

The number of display sessions connected to the specific HostFront service.

Prototype

public System.Int32 DisplaySessions

Member of HostFront.EAI.ClusterHFServiceInfo.

EmulationType

The type of emulation used by the specific HostFront service.

Prototype

public HostFront.EAI.Emulation EmulationType

Member of HostFront.EAI.ClusterHFServiceInfo

FileTransferSessions

The number of file transfer sessions connected to the specific HostFront service.

Prototype

public System.Int32 FileTransferSessions

Member of HostFront.EAI.ClusterHFServiceInfo.

IPAddress

The IP address of the box running the HostFront service.

Prototype

public System.String IPAddress

Member of HostFront.EAI.ClusterHFServiceInfo

PrinterSessions

The number of printer sessions connected to the specific HostFront service.

Prototype

public System.Int32 PrinterSessions

Member of HostFront.EAI.ClusterHFServiceInfo.

TotalSessions

The number of sessions connected to the specific HostFront service.

Prototype

public System.Int32 TotalSessions

Member of HostFront.EAI.ClusterHFServiceInfo

ClusterInfo class

This structure retrieves cluster information from the Cluster Server using the GetClusterInfo method of the QueryHost class.

Prototype

public sealed struct ClusterInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the ClusterInfo class.

ActiveSessions

The number of active sessions connected to the cluster.

Prototype

public System.Int32 ActiveSessions

Member of HostFront.EAI.ClusterInfo

ActiveUsers

The number of user accounts connected to the cluster.

Prototype

public System.Int32 ActiveUsers

Member of HostFront.EAI.ClusterInfo

Servers

Array for ClusterHFServiceInfo structures. Each structure represents a HostFront service running a specific emulation.

Prototype

public HostFront.EAI.ClusterHFServiceInfo [] Servers

Member of HostFront.EAI.ClusterInfo

QueryHost class

This class contains all of the static methods that retrieve information specific to the HostFront Server. Note that no connection to the Host is required. Each request uses the slow Http protocol, so it is important to make the request only once and store the return values globally.

Methods

The following methods are associated with the QueryHost class.

GetAccountInfo (String,String)

Retrieves information on a specific account defined within HostFront server, and is to be used only with Versions prior to 3.6.x.

Prototype

public static HostFront.EAI.AccountInfo GetAccountInfo (System.String server,System.String account)

Member of HostFront.EAI.QueryHost

Parameters

Server: The IP address or domain name of HostFront Server.

Account: The account name.

Return

Returns the ServerInfo structure containing the desired values.

GetAccountInfo (System.Uri,String)

Retrieves information on a specific account defined within HostFront server, and is to be used only with Versions prior to 3.6.x.

Prototype

public static HostFront.EAI.AccountInfo GetAccountInfo (System.String server,System.String account)

Member of HostFront.EAI.QueryHost

Parameters

requestUri: A System.Uri containing the URI of HostFront Server.

account: The account name.

Return

Returns the ServerInfo structure containing the desired values.

GetClusterInfo (System.Uri)

Retrieves information about the load of the cluster.

Note

This method must be used with HostFront version equal or later than 4.0.0.

Prototype

public static HostFront.EAI.ClusterInfo GetClusterInfo (Uri requestUri)

Member of HostFront.EAI.QueryHost

Parameters

requestUri: URI of the box (or one of the boxes) running the cluster service.

Return

Returns the ClusterInfo structure containing the desired values.

GetServerInfo (String)

Retrieves information about the existing connections in HostFront server.

Note

This method must be used with HostFront servers with version prior to 3.6.0. For versions equal to or later than 4.0.0, please use the GetClusterInfo method.

Prototype

public static HostFront.EAI.ServerInfo GetServerInfo (System.String server)

Member of HostFront.EAI.QueryHost

Parameters

Server: The IP address or domain name of HostFront Server.

Return

Returns the ServerInfo structure containing the desired values.

GetSessionStatus (String,System.NET.IPEndPoint)

Returns the status of a session. A session id must be provided, so remember to retrieve it from a TcpLink object before making the request in question.

Prototype

public static HostFront.EAI.SessionInfo GetSessionStatus (System.String sessionID , System.Net.IPEndPoint hostIP)

Member of HostFront.EAI.QueryHost

Parameters

sessionID: The session ID.

hostIP: The IP address and port used to connect to HostFront server.

Return

Returns the GetSessionStatus structure containing the desired values.

GetSessionStatus (String,System.Uri)

Returns the status of a session. A session id must be provided, so remember to retrieve it from a HttpLink object before making the request in question.

Prototype

public static HostFront.EAI.SessionInfo GetSessionStatus (System.String sessionID,System.Uri requestUri)

Member of HostFront.EAI.QueryHost

Parameters

sessionID: The session ID.

requestUri: A System.Uri containing the URI of HostFront Server.

Return

Returns the GetSessionStatus structure containing the desired values.

GetSessionStatusHFEE (String,System.NET.IPEndPoint)

Retrieves information about a specific session (TCP/IP mode).

Note

This method must be used with HostFront version equal or later than 4.0.0 (HFEE).

Prototype

public static HostFront.EAI.S SessionInfoHFEE GetSessionStatusHFEE (string sessionID,IPEndPoint hostIP)

Member of HostFront.EAI.QueryHost

Parameters

sessionID: ID of the session returned by either the Detach() method or the SessionID property of the HostLink class

hostIP: IP Address and port of the cluster service

Return

Returns the SessionInfoHFEE structure containing the desired values.

GetSessionStatusHFEE (String,System.Uri)

Retrieves information about a specific session (HTTP mode).

Note

This method must be used with HostFront version equal or later than 4.0.0.

Prototype

public static HostFront.EAI.S SessionInfoHFEE GetSessionStatusHFEE (string sessionID,Uri requestUri)

Member of HostFront.EAI.QueryHost

Parameters

sessionID: ID of the session returned by either the Detach() method or the SessionID property of the HostLink class.

requestUri: URI of the cluster service.

Return

Returns the SessionInfoHFEE structure containing the desired values.

ConnectionInfo class

Retrieves information of the current connection established with the HostFront Server.

Prototype

public sealed struct ConnectionInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the ConnectionInfo class.

DataStream

Defines the data stream from HostFront Server to the host. Possible values are: TN5250, APPC5250, TN3270 or SNA3270

Prototype

public System.String DataStream

Member of HostFront.EAI.ConnectionInfo

DeviceName

The name of the device.

Prototype

public System.String DeviceName

Member of HostFront.EAI.ConnectionInfo

HostName

The name of the host.

Prototype

public System.String HostName

Member of HostFront.EAI.ConnectionInfo

LUName

The LU name currently being used (not available for Display 5250).

Prototype

public System.String LUName

Member of HostFront.EAI.ConnectionInfo

Port

The socket port used by the HostFront server for a back-end Telnet connection. Only defined for TCP/IP connection.

Prototype

public System.Int32 Port

Member of HostFront.EAI.ConnectionInfo

ScreenField class

Methods

The following methods are associated with the ScreenField class.

Sets or gets information about a specific field of the current screen.

ToString

Returns the field information as a string: FLD_R<row>_C<column>_<data>

Prototype

string ToString ()

Parameters

None.

Properties

The following properties are associated with the ScreenField class.

AlphaNumeric

Indicates whether the field is alphaNumeric only or not.

Prototype

System.Boolean AlphaNumeric [get]

Member of HostFront.EAI.HostLink

AlphaOnly

Indicates whether the field is alpha only or not.

Prototype

System.Boolean AlphaOnly [get]

Member of HostFront.EAI.HostLink

AutoEnter

Indicates whether the field is autoenter or not.

Note

Even if the field is 'autoenter,' you still have to code the PushKey (Key.Enter) in your code.

Prototype

System.Boolean AutoEnter [get]

Member of HostFront.EAI.HostLink

Blinking

Indicates whether the field is blinking or not.

Prototype

System.Boolean Blinking [get]

Member of HostFront.EAI.HostLink

Column

Returns the first column of the field.

Prototype

int Column [get]

Member of HostFront.EAI.HostLink

DigitOnly

Indicates whether the field must contain digits only or not.

Prototype

System.Boolean DigitOnly [get]

Member of HostFront.EAI.HostLink

FieldExit

Indicates whether the field is field-exit or not.

Prototype

System.Boolean FieldExit [get]

Member of HostFront.EAI.HostLink

Highlighted

Indicates whether the field is highlighted or not.

Prototype

System.Boolean Highlighted [get]

Member of HostFront.EAI.HostLink

IsModified

Indicates whether the field is modified or not.

Prototype

System.Boolean IsModified [get]

Member of HostFront.EAI.HostLink

MandatoryEnter

Indicates whether the field is Mandatory Enter or not.

Prototype

System.Boolean MandatoryEnter [get]

Member of HostFront.EAI.HostLink

MaxLength

Returns the maximum length of the field.

Prototype

int MaxLength [get]

Member of HostFront.EAI.HostLink

NumericOnly

Indicates whether the field is numeric only or not.

Prototype

System.Boolean NumericOnly [get]

Member of HostFront.EAI.HostLink

Protected

Indicated whether the field is protected or not.

Prototype

System.Boolean Protected [get]

Member of HostFront.EAI.HostLink

ReadOnly

Indicates whether the field is read only or not.

Prototype

System.Boolean ReadOnly [get]

Member of HostFront.EAI.HostLink

Row

Returns the row position of the field.

Prototype

int Row [get]

Member of HostFront.EAI.HostLink

SignedNumeric

Indicates whether the field is signed-numeric only or not.

Prototype

System.Boolean SignedNumeric [get]

Member of HostFront.EAI.HostLink

TextColor

Returns the field's color As System.Drawing.Color.

Prototype

Color TextColor [get]Member of HostFront.EAI.HostLink

Underlined

Indicates whether the field is underlined or not.

Prototype

System.Boolean Underlined [get]

Member of HostFront.EAI.HostLink

UpperCase

Indicates whether the field is uppercase or not.

Prototype

System.Boolean UpperCase [get]

Member of HostFront.EAI.HostLink

Value

Sets or gets the value of the field.

Prototype

System.String Value [get,set]

Member of HostFront.EAI.HostLink

ScreenFields class

Methods

The following method is associated with the ScreenFields class.

GetEnumerator

Returns an IEnumerator that can iterate through the collection of field.

Prototype

public ScreenFieldsEnumerator GetEnumerator [ get ]

Member of HostFront.EAI

Properties

The following properties are associated with the ScreenFields class.

Count

Returns the number of fields handled by this instance of the class.

Prototype

public int Count [ get, set ]

Member of HostFront.EAI

Indexer

Permits instances of the ScreenField class to be indexed in the same way as arrays. The index type is an integer.

Prototype

public HostFront.EAI.ScreenField []

Member of HostFront.EAI

ScreenIdentifier class

This Class allows a host screen to be uniquely identified by some field identifier.

Prototype

public sealed struct ScreenIdentifier:System.ValueType

Member of HostFront.EAI.ConnectionType

Methods

The following methods are associated with the ScreenIdentifier class.

Returns information about some fields on the current screen.

ScreenIdentifier (System.String,System.Int32,System.Int32,System.Int32)

Initializes a screen identifier with a portion of a field on the host screen.

Prototype

public ScreenIdentifier (System.String fieldValue,System.Int32 row,System.Int32 columnStart , System.Int32 columnEnd)

Member of HostFront.EAI.ScreenIdentifier

Parameters

FieldValue: The field value.

Row: The starting row position of the field value.

ColumnStart: The starting column position of the field value.

ColumnEnd: The ending column position of the field value.

ScreenIdentifier (String,System.Int32,System.Int32)

Initializes a screen identifier with a whole field on the host screen.

Prototype

public ScreenIdentifier (System.String fieldValue,System.Int32 row,System.Int32 column)

Member of HostFront.EAI.ScreenIdentifier

Parameters

FieldValue: The field value.

Row: The starting row position of the field value.

Column: The starting column position of the field value.

Properties

The following methods are associated with the ScreenIdentifier class.

ColumnEnd

The ending column position of the field. If this value is 0 then the entire field will be used.

Prototype

public System.Int32 columnEnd

Member of HostFront.EAI.ScreenIdentifier

ColumnStart

The starting column position of the field identifier.

Prototype

public System.Int32 columnStart

Member of HostFront.EAI.ScreenIdentifier

FieldValue

The value of the field identifier.

Prototype

public System.String fieldValue

Member of HostFront.EAI.ScreenIdentifier

Row

The row position of the field identifier.

Prototype

public System.Int32 row

Member of HostFront.EAI.ScreenIdentifier

ServerInfo class

This class retrieves information from the HostFront Server.

Prototype

public sealed struct ServerInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the ServerInfo class.

ActiveSessions

The number of sessions connected to HostFront Server.

Prototype

public System.Int32 ActiveSessions

Member of HostFront.EAI.ServerInfo

ActiveUsers

The number of user accounts connected to HostFront Server.

Prototype

public System.Int32 ActiveUsers

Member of HostFront.EAI.ServerInfo

Sessions

The number of sessions allowed in HostFront Server.

Prototype

public System.Int32 Sessions

Member of HostFront.EAI.ServerInfo

Users

The number of user accounts defined within HostFront Server.

Prototype

public System.Int32 Users

Member of HostFront.EAI.ServerInfo

SessionInfo class

This class gives information pertaining to a session.

Prototype

public sealed struct ServerInfo:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the SessionInfo class.

Busy

Indicates that this session is still being processed within the server.

Prototype

public bool Busy [ get, set ]

Member of HostFront.EAI.SessionInfo

HostFrontServerAddress

Indicates the address of the HostFront Server to which this session is connected.

Prototype

public string HostFrontServerAddress [ get, set ]

Member of HostFront.EAI.SessionInfo

KeyboardLocked

Indicates whether the keyboard is locked.

Prototype

public bool KeyboardLocked [ get, set ]

Member of HostFront.EAI.SessionInfo

Message

Reflects a session status message.

Prototype

public string Message [ get, set ]

Member of HostFront.EAI.SessionInfo

SessionInfoHFEE class

Retrieves session information from Cluster Service.

Prototype

public sealed struct SessionInfoHFEE:System.ValueType

Member of HostFront.EAI

Properties

The following properties are associated with the SessionInfoHFEE class.

Busy

Indicates whether the session is still being processed within the server.

Prototype

public bool Busy [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

CnxTimeBusy

Indicates the time when the session was connected.

Prototype

public System.DateTime CnxTime [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

DeviceName

LU or Device name used by the session (if available).

Prototype

public string DeviceName [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

EmulationType

Type of emulation (HFA, HFM or HFU).

Prototype

public HostFront.EAI.Emulation EmulationType [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

HostFrontServerAddress

The public address of the HostFront server running the session.

Prototype

public string HostFrontServerAddress [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

HostName

Name of the backend host.

Prototype

public string HostName [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

KeyboardLocked

Indicates whether the keyboard is locked.

Prototype

public bool KeyboardLocked [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

Message

A session status message.

Prototype

public string Message [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

SessionName

Name of the session.

Prototype

public string SessionName [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

SessionType

Indicates type of session (0 = Display , 1 = Printer, 2 = File Transfer).

Prototype

public int SessionType [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

UserIPAddress

Indicates type of session (0 = Display , 1 = Printer, 2 = File Transfer).

Prototype

public int SessionType [ get, set ]

Member of HostFront.EAI.SessionInfoHFEE

XmlHost class

This class can only be created by the CreateXMLHost method within the Hostlink class. In order for the XML class to be defined, a connection to the Host must first be established. This class will then handle all future XML implementations concerning the screen content.

Methods

The following method is associated with the XmlHost class.

GetScreen (System.Xml.XmlTextWriter)

Retrieves all the screen information and outputs it into XML format.

Prototype

public void GetScreen ( System.Xml.XmlTextWriter writer )

Member of HostFront.EAI.Xml.XmlHost

Parameters

writer: The XmlTextWriter to write to. It is assumed that the XmlTextWriter is already set to the correct encoding.

Properties

The following property is associated with the XmlHost class.

HostLink

Returns a reference to the internal HostLink object. One can create another XML object, reference this buffer, and add the desired XML methods.

Prototype

public HostFront.EAI.HostLink HostLink [ get]

Member of HostFront.EAI.Xml.XmlHost