.NET ScriptAPI Method Reference

.NET ScriptAPI Method Reference

Show / Hide Table of Contents
  • Attachmate.Verastream.HostIntegrator.ScriptAPI
    • AppConnAidKey
    • ApptrieveException
    • AttributeEventHandler
    • ColumnType
    • ColumnValue
    • ContextType
    • CursorPosition
    • DescriptionAttribute
    • EchoType
    • EntityEventHandler
    • ErrorMessage
    • EventHandlerConstant
    • EventHandlerType
    • EventInfo
    • EventTimeoutException
    • FieldEventHandler
    • HostColor
    • HostFont
    • IApplyFilterEvent
    • IAttributeEvent
    • IAttributeMetaData
    • IAuthenticateUserEvent
    • IClientConnectedEvent
    • IClientDisconnectedEvent
    • IClientSession
    • IClientSessionCreatedEvent
    • IClientSessionDestroyedEvent
    • IColumnMetaData
    • IEntityArrivalEvent
    • IEntityDepartureEvent
    • IEntityEvent
    • IEntityMoveCursorEvent
    • IErrorReportedEvent
    • IEvent
    • IEventHandler
    • IExecuteLoginEvent
    • IExecuteLogoutEvent
    • IExecuteOperationEvent
    • IExecuteProcedureEvent
    • IFieldEvent
    • IFieldLocation
    • IFieldMetaData
    • IFormatErrorEvent
    • IGetCurrentHostRecordEvent
    • IGetRecordTypeEvent
    • IHostSession
    • IHostSessionCreatedEvent
    • IHostSessionDestroyedEvent
    • IHostSessionEvent
    • IInsertRecordEvent
    • IIsTerminatedEvent
    • ILifeCycleEvent
    • ILinearTerminalRegion
    • ILogger
    • IMetaData
    • IModelContext
    • IModelCursorEvent
    • IModelEvent
    • IModelLoadedEvent
    • IModelMoveCursorBackwardEvent
    • IModelMoveCursorEvent
    • IModelMoveCursorForwardEvent
    • IModelRecord
    • IModelRecordSet
    • IModelUnloadedEvent
    • IMutableProcedureRecord
    • IMutableProcedureRecordSet
    • IOperationMetaData
    • IParseRecordEvent
    • IParseScreenEvent
    • IProcedureMetaData
    • IProcedureParameters
    • IProcedureRecord
    • IProcedureRecordSet
    • IProcessStringEvent
    • IReadAttributeEvent
    • IReadFieldEvent
    • IRecord
    • IRecordEvent
    • IRecordLocation
    • IRecordSet
    • IRecordSetContext
    • IRecordSetEvent
    • IRecordSetMetaData
    • IRecordSetScreen
    • IRectangularTerminalRegion
    • IScriptHostSession
    • ITerminalAttributes
    • ITerminalCell
    • ITerminalRegion
    • IUnrecognizedScreenEvent
    • IUpdateRecordEvent
    • IVariableMetaData
    • IWriteAttributeEvent
    • IWriteAttributesEvent
    • IWriteFieldEvent
    • IndexValue
    • LifeCycleEventHandler
    • MetaDataType
    • ModelEventHandler
    • OperationEventHandler
    • ProcedureEventHandler
    • ProcedureType
    • RecordSetEventHandler
    • RecordType
    • RegionType
    • RowValue
    • ScreenSize
    • ScrollDirection
    • ScrollMovement
    • TimeoutAttribute
    • VariableInitialization
    • VariableKind
  • Attachmate.Verastream.HostIntegrator.ScriptAPI.Command
    • CheckOperationConditions
    • Command
    • DefaultValue
    • MoveCursor
    • Navigate
    • ReadFromMappedAttribute
    • ReadVariableFromAttribute
    • ReadVariableFromField
    • ReadVariableFromLocation
    • ReadVariableFromTerminal
    • ResetRecordSet
    • Transmit
    • TransmitTerminalKey
    • TransmitToAttribute
    • TransmitToField
    • TransmitToLocation
    • TransmitToOffset
    • UpdateAttribute
    • UpdateAttributes
    • UpdateRecordSetField
    • UpdateRecordSetFields
    • WaitForCommString
    • WaitForCondition
    • WaitForCursorAtAttribute
    • WaitForCursorAtLocation
    • WaitForCursorAtRecordSetField
    • WaitForCursorAtTerminalField
    • WaitForCursorNotAtLocation
    • WaitForCursorNotAtTerminalField
    • WaitForDisplayString
    • WaitForHostSilence
    • WaitForKeyboardEnabled
    • WaitForMultipleEvents
    • WaitForNewHostScreen
    • WaitForUpdate
    • WaitMS
    • WriteToMappedAttribute
    • WriteVariableToAttribute
    • WriteVariableToField
    • WriteVariableToLocation
    • WriteVariableToTerminal
  • WRQ.Verastream.HostIntegrator
    • RcConst

Namespace Attachmate.Verastream.HostIntegrator.ScriptAPI

Classes

ApptrieveException

The ApptrieveException class provides information on errors that occur during the use of a Host Integrator Server.

AttributeEventHandler

Abstract base class for an attribute event listener.

CursorPosition

An immutable class that represents a cursor position on a screen.

DescriptionAttribute

Used to define the description on an event handler class.

EntityEventHandler

Abstract base class for an entity event handler.

ErrorMessage

Describes a single runtime error.

EventInfo

Immutable object that provides information about an event in progress.

EventTimeoutException

Describes timeouts that occur during the event handling.

FieldEventHandler

Abstract base class for a field event listener.

LifeCycleEventHandler

Abstract base class for a lifecycle event handler.

ModelEventHandler

Abstract base class for a model event handler.

OperationEventHandler

Abstract base class for an operation event handler.

ProcedureEventHandler

Abstract base class for a procedure event handler.

RecordSetEventHandler

Abstract base class for a recordset event handler.

ScreenSize

An immutable class that represents the size of the terminal screen.

TimeoutAttribute

Used to define the timeout duration for an event method in units of seconds.

Structs

ColumnValue

Special Column values

IndexValue

Special Record Index values

RowValue

Special Row values

Interfaces

IApplyFilterEvent

Apply filter event information.

IAttributeEvent

Attribute event information.

IAttributeMetaData

Provides metadata about an attribute that is defined on an entity of a Host Integrator model.

IAuthenticateUserEvent

Authenticate user event information.

IClientConnectedEvent

Client connected event information.

IClientDisconnectedEvent

Client disconnected event information.

IClientSession

Provides information about the currently connected client.

IClientSessionCreatedEvent

Client session created event information.

IClientSessionDestroyedEvent

Client session destroyed event information.

IColumnMetaData

The methods and properties in the IColumnMetaData interface manage data based in table columns.

IEntityArrivalEvent

Entity arrival event information.

IEntityDepartureEvent

Entity departure event information.

IEntityEvent

Entity event information.

IEntityMoveCursorEvent

Entity move cursor event information.

IErrorReportedEvent

Error reported event information.

IEvent

Base interface for script events.

IEventHandler

Tag interface that identifies a class as a VHI script event handler.

IExecuteLoginEvent

Execute login event information.

IExecuteLogoutEvent

Execute logout event information.

IExecuteOperationEvent

Execute operation event information.

IExecuteProcedureEvent

Execute procedure event information.

IFieldEvent

Field event information.

IFieldLocation

Specifies the location of a field within a recordset record.

IFieldMetaData

The methods and properties in the FieldMetaData class manage fields.

IFormatErrorEvent

Format error event information.

IGetCurrentHostRecordEvent

Get current host record event information.

IGetRecordTypeEvent

Get record type event information.

IHostSession

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

IHostSessionCreatedEvent

Host session created event information.

IHostSessionDestroyedEvent

Host session destroyed event information.

IHostSessionEvent

Host session event information.

IInsertRecordEvent

Insert record event information.

IIsTerminatedEvent

Is terminated event information.

ILifeCycleEvent

Life cycle event information.

ILinearTerminalRegion

Represents a linear terminal region.

ILogger

Provides access to the VHI logging facilities.

IMetaData

The methods and properties in the IMetaData interface provide information on Host Integrator metadata.

IModelContext

Provides information about the model and a model scoped shared storage.

IModelCursorEvent

Model cursor event information.

IModelEvent

Model event information.

IModelLoadedEvent

Model loaded event information.

IModelMoveCursorBackwardEvent

Model move cursor backward event information.

IModelMoveCursorEvent

Model move cursor event information.

IModelMoveCursorForwardEvent

Model move cursor forward event information.

IModelRecord

A record in a IModelRecordSet.

IModelRecordSet

The result of fetching records from a recordset in a model.

IModelUnloadedEvent

Model unloaded event information.

IMutableProcedureRecord

A IProcedureRecord whose contents can be modified.

IMutableProcedureRecordSet

A IProcedureRecordSet whose contents can be modified.

IOperationMetaData

The methods and properties in the OperationMetaData class manage operation metadata.

IParseRecordEvent

Parse record event information.

IParseScreenEvent

Parse screen event information.

IProcedureMetaData

The methods and properties in the ProcedureMetaData class manage procedure metadata.

IProcedureParameters

Input filter and data parameters for a procedure.

IProcedureRecord

A record in a IProcedureRecordSet. Column values can be accessed by either column name or a zero-based index.

IProcedureRecordSet

The result of executing a table procedure.

IProcessStringEvent

Process string event information.

IReadAttributeEvent

Read attribute event information.

IReadFieldEvent

Read field event information.

IRecord

A record in a IRecordSet. Column values can be accessed by either column name or a zero-based index.

IRecordEvent

Record set event information.

IRecordLocation

Specifies the location of a record within a recordset.

IRecordSet

A table of data.

IRecordSetContext

Stores state information for a recordset and its records.

IRecordSetEvent

Record set event information.

IRecordSetMetaData

The methods and properties in the RecordSetMetaData class manage recordset metadata.

IRecordSetScreen

A record set that describes the contents of the current screen.

IRectangularTerminalRegion

Represents a rectangular terminal region.

IScriptHostSession

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

ITerminalAttributes

The methods and properties in the TerminalAttributes class return information about the terminal attributes of the associated field.

ITerminalCell

Represents a character on the terminal screen.

ITerminalRegion

Provides information about a region of the terminal screen.

IUnrecognizedScreenEvent

Unrecognized screen event information.

IUpdateRecordEvent

Update record event information.

IVariableMetaData

The methods and properties in the VariableMetaData class manage model variable metadata.

IWriteAttributeEvent

Write attribute event information.

IWriteAttributesEvent

Write attributes event information.

IWriteFieldEvent

Write field event information.

Enums

AppConnAidKey

Defines a set of constants used by the TransmitTerminalKey(AppConnAidKey) method, and the TransmitTerminalKey class.

ColumnType

Defines a set of constants that can be returned by the ColumnType property.

ContextType

Indicate the Context for the value of a Model Variable.

EchoType

Options specifying how to react to echoed data after writing.

EventHandlerConstant

Constant enumeration for event handler tag interface.

EventHandlerType

Constant enumeration for event handler types.

HostColor

Color enumerator

HostFont

Represents font indexes.

MetaDataType

Identifies the kind of metadata an object represents.

ProcedureType

Defines a set of constants that can be returned by the ProcedureType property.

RecordType

Enumerates values that can be returned from the GetRecordType event.

RegionType

Values to indicate the type of a Region.

ScrollDirection

Enumerates scroll directions.

ScrollMovement

Defines a set of constants used by the MoveCurrentRecordIndex(ScrollMovement) method and the ScrollOperations property.

VariableInitialization

Defines a set of constants that can be returned by the InitType property.

VariableKind

Defines a set of constants that can be returned by the Kind property.

In This Article
Back to top © 1985-2024 Rocket Software, Inc. or its affiliates. All Rights Reserved