An NDoc Documented Class Library

HostIntegratorSession Methods

The methods of the HostIntegratorSession class are listed below. For a complete list of HostIntegratorSession class members, see the HostIntegratorSession Members topic.

Public Instance Methods

ConnectToModelOverloaded. Establishes a connection to a Host Integrator server and creates a host session with the specified model.
ConnectToModelViaDomainOverloaded. Establishes a connection to a Host Integrator server and creates a host session with the specified model. The connection is made using the specified AADS server and Host Integrator domain. This version of ConnectToModelViaDomain presents a user ID and a password, to establish authorization on the Host Integrator server, and also provides a set of model variables, to set upon connection.
ConnectToSessionOverloaded. Establishes a connection to a Host Integrator server and creates or allocates a host session with the specified session pool. This version of ConnectToSession presents a user ID and a password, to establish authorization on the Host Integrator server, and also provides a set of model variables, to set upon connection.
ConnectToSessionViaDomainOverloaded. Establishes a connection to a Host Integrator server and creates or allocates a host session with the specified session pool. The connection is made using the specified AADS server and Host Integrator domain. This version of ConnectToSessionViaDomain presents a user ID and a password, to establish authorization on the Host Integrator server, and also provides a set of model variables, to set upon connection.
Disconnect Disconnects from a Host Integrator server session.
EnableTerminalAttributesOverloaded. Enables the availability of terminal attributes when retrieving attribute or field data from the Host Integrator server.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExecuteSQLStatementOverloaded. Executes an SQL statement on a table defined in the model.
FetchRecordsOverloaded. Fetches data from the Host Integrator server for the current recordset of the current entity.
GetAttributeAtCursor Gets the name of the attribute at the current cursor position.
GetAttributeLocationsOverloaded. Gets locations for attributes of the current entity.
GetAttributeMetaData Gets metadata for the specified attribute and entity in the Host Integrator model.
GetAttributesOverloaded. Gets attributes for the current entity.
GetColumnMetaData Gets metadata for a table column in the Host Integrator model.
GetCurrentEntity Gets the name of the current entity in the Host Integrator model.
GetCurrentRecord Get the current record
GetCurrentRecordIndex Gets the index number of the current record in the current recordset.
GetCurrentRecordSetName Gets the name of the current recordset.
GetEntityAttributes Gets the names of the attributes for the specified entity in the Host Integrator model.
GetEntityDescription Gets the description for the specified entity in the Host Integrator model.
GetEntityOperations Gets the names of the operations in the specified entity.
GetEntityRecordSets Gets the names of the recordsets in the specified entity.
GetFieldLocationsOverloaded. Gets field locations for the current record in the current recordset in the current entity.
GetFieldMetaData Gets metadata for the specified field in the specified recordset and entity in the Host Integrator model.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHomeEntityName Gets the name of the home entity for the current Host Integrator model.
GetLastRequestID Gets an identifier for the most recent request performed against the current Host Integrator server session.
GetLocale Gets the locale for the current session.
GetLoggingLevel Gets the logging level for the current Host Integrator session.
GetMajorVersion Get the major VHI product version
GetMinorVersion Gets the minor version number for the locally installed Verastream software.
GetModelEntities Gets the names of the entities in the current Host Integrator model.
GetModelVariableNames Gets the names of all non-hidden model variables in the Host Integrator model.
GetModelVariables Gets the values of all non-hidden model variables in the current Host Integrator model.
GetOperationMetaData Gets metadata for an operation in the current Host Integrator model.
GetPatternLocationsOverloaded. Gets the locations for the specified patterns for the current entity.
GetProcedureMetaData Gets metadata for a table procedure in the Host Integrator model.
GetRecordSetLocationsOverloaded. Gets the locations for the specified recordsets in the current entity.
GetRecordSetMetaData Gets metadata for a recordset in the specified entity.
GetSessionID Gets an identifier for the current Host Integrator session.
GetStringAtOffset Gets a string of the specified length, starting at the specified offset, from the current entity.
GetStringAtRowColumn Gets a string from a rectangular region of the current entity.
GetTableColumns Gets the column names for a table in the Host Integrator model.
GetTableDescription Gets the description for a table in the Host Integrator model.
GetTableNames Gets the names of all tables in the Host Integrator model.
GetTableProcedures Gets the procedure names for a table in the Host Integrator model.
GetTerminalFieldAtCursor Gets a TerminalField object that contains information about the terminal field at the current cursor position on the Host Integrator screen.
GetType (inherited from Object)Gets the Type of the current instance.
GetVariableMetaData Gets metadata for a model variable in the Host Integrator model.
GetVersionString Gets the version string for the Verastream .NET connector. This string is of the form majorVersion.minorVersion.
InsertRecord Performs an insert operation for the current recordset.
InsertRecords Performs the insert operation for the current recordset multiple times.
InsertStringAtCursor Inserts the specified string into the current entity on the Host Integrator server starting at the current cursor position.
InsertStringAtOffset Inserts a string into the current entity on the Host Integrator server starting at an offset.
InsertStringAtRowColumn Inserts a string into the current entity on the Host Integrator server starting at the given row and column location.
MoveCurrentRecordIndex Moves the current record index to a new position in the current recordset.
NextRecordOverloaded. Finds and returns a record in the current recordset using a filter expression.
PerformAidKey Enters an aid key (for example, a Program Function key) into the current Host Integrator server session.
PerformEntityOperation Performs an operation on the current entity.
PerformTableProcedureOverloaded. Performs a SELECT or a DELETE procedure on a table defined in the model.
ProcessString Calls the ProcessString event handler on the server.
RequireSecureConnection Requires a secure channel on the next connection to a Host Integrator server.
ResumeConnection Resumes the execution of a currently suspended Host Integrator server session.
SelectCurrentRecord Selects the current record in the current recordset.
SelectRecordByFilter Finds a record in the current recordset using a filter expression, and perform a selection operation.
SelectRecordByIndex Performs its selection operation on a record in the current recordset. The record to select is determined by the specified index number.
SetAttributesOverloaded. Sets the attributes for the current entity.
SetAttributesDelayedOverloaded. Sets the attributes for the specified entity. Attributes are not actually set until the entity is reached.
SetCurrentEntity Sets the current entity.
SetCurrentRecordIndex Sets the current record in the current recordset, using the record's index number.
SetCurrentRecordSetByName Sets the current recordset, by name.
SetLocale Sets the locale for the current session.
SetLoggingLevel Sets the logging level for the current Host Integrator session.
SetModelVariables Sets the values of variables in the current Host Integrator model.
SuspendConnection Suspends the execution of a currently running Host Integrator server session.
ToString (inherited from Object)Returns a String that represents the current Object.
UpdateCurrentRecordOverloaded. Sets the values for the current record in the current recordset.
UpdateRecordByFilterOverloaded. Changes the values of a record in the current recordset. The record that gets changed is the first one after the current record that satisfies the filter expression.
UpdateRecordByIndexOverloaded. Changes the values of a record in the current recordset. The record to change is determined by the specified index number.
UpdateRecordsOverloaded. Updates the values of records in the current recordset, after the current record, that satisfy the specified filter expression.
WaitForConditionOverloaded. Waits for a condition to be fulfilled.
WaitForCursor Waits for the presence of the terminal cursor at the specified terminal screen coordinates.
WaitForEntityChangeObsolete. Waits for the recognition of any entity other than the specified entity.
WaitForString Waits for the presence of the specified string starting at the specified screen coordinates.
WaitForStringRelCursor Waits for the presence of a string at a screen location relative to the current terminal screen cursor.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

HostIntegratorSession Class | WRQ.Verastream.HostIntegrator Namespace