Interface Session
Encapsulates a Host Integrator session.
Namespace: Attachmate.Verastream.HostIntegrator.E2V
Assembly: Attachmate.Verastream.HostIntegrator.E2V.dll
Syntax
[ComVisible(true)]
public interface SessionProperties
Application
Returns the System object. Read-only.
Declaration
System Application { get; }Property Value
| Type | Description |
|---|---|
| System |
FullName
Returns the VHI model name. Read-only.
Declaration
string FullName { get; }Property Value
| Type | Description |
|---|---|
| string |
Height
In EXTRA!, this would return or set the height of the session window in pixels. In Host Integrator, there is never a session window, and always returns 0.
Declaration
short Height { get; set; }Property Value
| Type | Description |
|---|---|
| short |
Left
In EXTRA!, this would return or set the horizontal position of the session window in pixels. In Host Integrator, there is never a session window, and always returns 0.
Declaration
int Left { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Name
The name of the session: the VHI Session ID.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Parent
Returns the parent of the specified object. Read-only.
Declaration
Sessions Parent { get; }Property Value
| Type | Description |
|---|---|
| Sessions |
Screen
Returns the Screen object associated with the session.
Declaration
Screen Screen { get; }Property Value
| Type | Description |
|---|---|
| Screen |
Top
In EXTRA!, this would return or set the vertical position of the session window in pixels. In Host Integrator, there is never a session window, and always returns 0.
Declaration
int Top { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Type
The Type property returns a value indicating the session type -- 3270, 5250, or VT. Read-only.
Declaration
short Type { get; }Property Value
| Type | Description |
|---|---|
| short |
VhiSession
The VHI session that is backing this Extra Session. This property is only available in the E2V .NET interface, not in the COM interface.
Declaration
[ComVisible(false)]
HostIntegratorRejuvenationSession VhiSession { get; }Property Value
| Type | Description |
|---|---|
| HostIntegratorRejuvenationSession |
Visible
In Extra, this made the session window to visible or invisible, or returns its visibility status. In Host Integrator, there is never a session window, and always returns 0.
Declaration
int Visible { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Width
In EXTRA!, this would return or set the width of the session window in pixels. In Host Integrator, there is never a session window, and always returns 0.
Declaration
int Width { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Methods
Close()
Close (Disconnect) the Host Integrator session.
Declaration
void Close()CloseEx(short)
Close (Disconnect) the Host Integrator session.
Declaration
void CloseEx(short Options = 0)Parameters
| Type | Name | Description |
|---|---|---|
| short | Options | The parameter Options is here for compatibility and has no effect. |
NavigateTo(string)
Navigates to a specified host screen (An entity in the VHI model).
Declaration
bool NavigateTo(string screenName)Parameters
| Type | Name | Description |
|---|---|---|
| string | screenName | The name of the screen (An entity in the VHI model) to navigate to. |
Returns
| Type | Description |
|---|---|
| bool | false if the specified screen cannot be located |