An NDoc Documented Class Library

WRQ.Verastream.HostIntegrator Namespace

Namespace hierarchy

Classes

Class Description
AttributeMetaData

The methods and properties in the AttributeMetaData class manage attribute metadata.

ColumnMetaData

The methods and properties in the ColumnMetaData class manage data based in table columns.

ElementLocation

The methods and properties in the ElementLocation class provide information from the element location.

ErrorMessage Describes a single runtime error. An ErrorMessage has an error code, zero or more parameters, generic error text, and localized error text. Error parameters can either be objects of type String or Int32. Objects of this type are immutable. To create an ErrorMessage object in an event handler, use the appropriate createErrorMessage method.
FieldMetaData

The methods and properties in the FieldMetaData class manage fields.

HostIntegratorChannelException

The methods and properties in the HostIntegratorChannelException class provide information on errors that occur in the network interactions with the Host Integrator server.

HostIntegratorConnectorException

The methods and properties in the HostIntegratorConnectorException class provide information on errors that occur in the Verastream connector.

HostIntegratorDeadSessionException The HostIntegratorDeadSessionException class provides information on errors that occur at the Host Integrator server resulting from fatal errors that occur between the Host Integrator server and the host's terminal session. The condition is not recoverable.
HostIntegratorException

The methods and properties in the HostIntegratorException class provide information on any errors that occur with the Verastream .NET API.

HostIntegratorMarshallerException The HostIntegratorMarshallerException class provides information on errors that occur in the network type marshaller.
HostIntegratorModelDataException The HostIntegratorModelDataException class provides information on errors that occur at the Host Integrator server resulting from bad arguments passed in method calls.
HostIntegratorModelDefException

The methods and properties in the HostIntegratorModelDefException class provide information on errors that occur at the Host Integrator server resulting from bad arguments passed in method calls, particularly those that refer to non-existent model elements (for example, an entity name that is not defined in the model).

HostIntegratorRejuvenationSession

This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.

HostIntegratorServerException The HostIntegratorServerException class provides information on errors that occur at the Host Integrator server.
HostIntegratorSession HostIntegratorSession is the primary class used to communicate with the Host Integrator Server.
HostIntegratorTerminalException The HostIntegratorTerminalException class provides information on errors that occur at the Host Integrator server resulting from errors that originate on the host's terminal session.
HostIntegratorTimeoutException The HostIntegratorTimeoutException class is used to relay method call timeouts to the user.
HostIntegratorUserException The HostIntegratorUserException class provides information on errors that occur at the Host Integrator server dealing with error conditions defined by the model author.
InputFieldInfo

This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.

MetaData

The methods and properties in the MetaData class provide information on Host Integrator metadata. This class also serves as the base class for all other kinds of metadata used in Host Integrator.

ModelDataColumn

The methods and properties in the ModelDataColumn class extend the the DataColumn class, with functionality specific to Host Integrator.

ModelDataTable

The methods and properties in the ModelDataTable class extend the the DataTable class, with functionality specific to Host Integrator.

OperationMetaData

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

ProcedureMetaData

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

RecordSetMetaData

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

Screen

This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.

ScreenField ScreenField provides information about a field on the terminal screen.
TerminalAttributes

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

TerminalField

The properties in this class return information about the associated terminal field.

TerminalScreen TerminalScreen represents a terminal screen. It contains methods that allow an entity or an unrecognized screen to be displayed, for example, as a web page.
VariableMetaData

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

Enumerations

Enumeration Description
AidKey Defines a set of constants used by the PerformAidKey method.
Color Color constants
ColumnType

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

ElementType

The methods and properties in the ElementLocation class provide information from the element location.

LoggingLevel

Defines a set of constants used by the GetLoggingLevel and SetLoggingLevel methods.

MetaDataType Metadata object type constants
ProcedureType

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

RegionType

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

RejuvenationAidKey

This enumeration supports the Verastream .NET API framework and is not intended to be used directly in your code.

RejuvenationEnablementMode

This enumeration supports the Verastream .NET API framework and is not intended to be used directly in your code.

RejuvenationMethod

This enumeration supports the Verastream .NET API framework and is not intended to be used directly in your code.

ScrollMovement

Defines a set of constants used by the MoveCurrentRecordIndex method and the ScrollMovements property.

SessionType

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

VariableInitialization

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

VariableType

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