Click or drag to resize

OhioSession Class

Represents a host session. It provides methods to connect to and disconnect from the host and events to monitor events from the host.
Inheritance Hierarchy
SystemObject
  Flex.Hal.OhioOhioSession

Namespace:  Flex.Hal.Ohio
Assembly:  Flex.Hal.Ohio (in Flex.Hal.Ohio.dll) Version: 4.1.4031.1525
Syntax
public class OhioSession

The OhioSession type exposes the following members.

Properties
  NameDescription
Public propertyHllapiLongName
Gets the current HLLAPI long name; empty string if session is disconnected.
Public propertyHllapiShortName
Gets the current HLLAPI short name; '\0' if session is disconnected.
Public propertyIsConnected
Gets a value that indicates if the session is connected.
Public propertyIsFileTransferInProgress
Gets a value that indicates if a file transfer (IND$FILE or FTP) is currently in progress.
Public propertyScreen
Gets the OhioScreen object of the session.
Public propertySessionName
Gets the session name (a six digit number).
Public propertySessionType
Gets the session type.
Public propertyTransferErrorMessage
Gets the most recent file transfer error if any.
Top
Methods
  NameDescription
Public methodConnectAsync
Asynchronously starts the communications link with the host.
Public methodDisconnectAsync
Asynchronously stops the communications link to the host.
Public methodFtpRecvAsync
Performs an FTP file receive from the host.
Public methodFtpSendAsync
Performs an FTP file send to the host.
Public methodIndRecvAsync
Performs an IND$FILE receive file from the host.
Public methodIndSendAsync
Performs an IND$FILE send file to the host.
Top
Events
  NameDescription
Public eventOIAChanged
Occurs when the Operator Information Area (OIA) changes.
Public eventScreenChanged
Occurs when the virtual screen is modified.
Public eventSessionChanged
Occurs when the session state changes.
Public eventSessionError
Occurs when a session error condition occurs.
Public eventSessionStatus
Occurs when the session status changes.
Public eventTransferError
Occurs when there is a file transfer error.
Public eventTransferProgress
Occurs when file transfer makes progress.
Public eventTransferStatus
Occurs when file transfer status changes.
Top
See Also