Interface IScriptHostSession

Provides information about the scripted host session and allows for the manipulation of the terminal at various levels (direct, model, table).

Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IScriptHostSession : IHostSession

Properties

HostSessionID

Gets the VHI host session ID.

Declaration
int HostSessionID { get; }
Property Value
Type Description
int

host session ID

Methods

ConnectToHost()

Connects to the host.

Declaration
void ConnectToHost()
Remarks

Connects to the host. Upon returning from this method a connection will have been established with the host, but the login command list will not have been executed.

Exceptions
Type Condition
ApptrieveException

DisconnectFromHost()

Disconnects from the host.

Declaration
void DisconnectFromHost()
Remarks

Disconnects from the host. Calling this method immediately drops the connection without navigating home and without executing the logout command list.

Exceptions
Type Condition
ApptrieveException

ExecuteLogin()

Executes the login command list.

ApptrieveException

Declaration
void ExecuteLogin()

ExecuteLogout()

Executes the logout command list.

ApptrieveException

Declaration
void ExecuteLogout()

GetHostStateObject(string)

Gets the object bound to the specified name in this host session, or null if no object is bound to the name.

Declaration
object GetHostStateObject(string name)
Parameters
Type Name Description
string name

the name of the object
Returns
Type Description
object

the object bound to the specified name or null if none

IsHostStateObject(string)

Tests for the presence of a host state object bound to the specified name.

Declaration
bool IsHostStateObject(string name)
Parameters
Type Name Description
string name

the name of the object
Returns
Type Description
bool

true if an object is bound to the specified name

SetHostStateObject(string, object)

Binds an object to this host session, using the name specified.

Declaration
void SetHostStateObject(string name, object obj)
Parameters
Type Name Description
string name

the name to which to bind the object
object obj

the object to bind
Remarks

Binds an object to this host session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.