Gets or sets how long Host Integrator continues attempting to establish a connection if for any reason the connection cannot be established on the first try (in seconds).

Declaration

public virtual int ConnectionTimeout { get; set; }

Property Value

Type	Description
int	This property gets or sets how long Host Integrator continues attempting to establish a connection if for any reason the connection cannot be established on the first try (in seconds).

Remarks

This property is useful, for example, if the server is temporarily unable to allow any more sessions, or if the domain load has been reached. Connection attempt information, including the number of connection attempts and the time of those attempts, is written to the log.

The default value is 30 seconds.

ErrorScreen

ErrorScreen property

Declaration

public virtual TerminalScreen ErrorScreen { get; }

Property Value

Type	Description
TerminalScreen

IsConnected

Gets whether the Host Integrator server session is connected.

Declaration

public virtual bool IsConnected { get; }

Property Value

Type	Description
bool	Gets whether the Host Integrator server session is connected.

Remarks

This property returns True if HostIntegratorSession believes it is currently connected to a Host Integrator server session. This property does not actually perform a server operation to determine whether a connection is present. It is possible for the connection to have been lost without the connector detecting it. So isConnected might return True even when a connection is not present.

IsSecureConnection

Gets whether the Host Integrator server session is using an encrypted connection.

Declaration

public virtual bool IsSecureConnection { get; }

Property Value

Type	Description
bool	Gets whether the Host Integrator server session is using an encrypted connection.

Remarks

Returns True if the connection is encrypted; False otherwise.

MetaDataOnly

Sets or gets whether the current session is "metadata only."

Declaration

public virtual bool MetaDataOnly { get; set; }

Property Value

Type	Description
bool	Sets or gets whether the current session is "metadata only."

Remarks

A metadata only session does not require a host connection and allows only methods and properties that interact with metadata. You must set MetaDataOnly to true before you use a Connect method.

Once a connect method has been called, and before the Disconnect method has been called, any attempt to change the value of the MetaDataOnly property will generate an error with this text: "The MetaDataOnly property cannot be changed while a connection is active."

When a client connects with MetaDataOnly set to true, the server will not report the connection as a session, and will not allocate a new session or a session from a pool. There will be no indication in the Admin Web Station or Session Monitor that there is an active client connection.

Exceptions

Type	Condition
HostIntegratorException	Thrown if session is already connected

MethodTimeout

Gets or sets the method timeout for a Host Integrator server session (in milliseconds).

Declaration

public virtual int MethodTimeout { get; set; }

Property Value

Type	Description
int	Gets or sets the method timeout for a Host Integrator server session (in milliseconds).

Remarks

This property fails if a server session has not been established.

ModelName

Gets the name of the Host Integrator model for the current session.

Declaration

public virtual string ModelName { get; }

Property Value

Type	Description
string	Gets the name of the Host Integrator model for the current session.

Remarks

If a session is not active, this method returns null.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

ModelVersionString

Gets the version of the model.

Declaration

public virtual string ModelVersionString { get; }

Property Value

Type	Description
string	Gets the version of the model.

Remarks

The string returned uniquely identifies the version of the model deployed to the Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

ServerName

Gets the name of the Host Integrator server for the current session.

Declaration

public virtual string ServerName { get; }

Property Value

Type	Description
string	Gets the name of the Host Integrator server for the current session.

Remarks

When there is no current session, this property returns null.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

SessionType

Gets the terminal emulation type of the host session.

Declaration

public virtual SessionType SessionType { get; }

Property Value

Type	Description
SessionType	The value returned is a member of the SessionType enumeration.

Remarks

Gets the terminal emulation type of the host session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

Methods

ConnectToModel(string, string)

Establishes a connection to a Host Integrator server and creates a host session with the specified model.

Declaration

public virtual void ConnectToModel(string server, string modelName)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	modelName	Specifies the name of a Host Integrator model.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid model name.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModel(string, string, IDictionary)

Establishes a connection to a Host Integrator server and creates a host session with the specified model.

Declaration

public virtual void ConnectToModel(string server, string modelName, IDictionary modelVariables)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	modelName	Specifies the name of a Host Integrator model.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid model name.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModel(string, string, string, string)

Establishes a connection to a Host Integrator server and creates a host session with the specified model.

Declaration

public virtual void ConnectToModel(string server, string modelName, string userid, string password)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	modelName	Specifies the name of a Host Integrator model.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid model name.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModel(string, string, string, string, IDictionary)

Establishes a connection to a Host Integrator server and creates a host session with the specified model.

Declaration

public virtual void ConnectToModel(string server, string modelName, string userid, string password, IDictionary modelVariables)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	modelName	Specifies the name of a Host Integrator model.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid model name.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModelViaDomain(string, string, string)

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.

Declaration

public virtual void ConnectToModelViaDomain(string directoryServer, string domain, string modelName)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	modelName	Specifies the name of a Host Integrator model.

Remarks

Reasons for failure include:

Failure to locate Host Integrator domain server.
Invalid model name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModelViaDomain(string, string, string, IDictionary)

Declaration

public virtual void ConnectToModelViaDomain(string directoryServer, string domain, string modelName, IDictionary modelVariables)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	modelName	Specifies the name of a Host Integrator model.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Failure to locate Host Integrator domain server.
Invalid model name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModelViaDomain(string, string, string, string, string)

Declaration

public virtual void ConnectToModelViaDomain(string directoryServer, string domain, string modelName, string userid, string password)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	modelName	Specifies the name of a Host Integrator model.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.

Remarks

Reasons for failure include:

Failure to locate Host Integrator domain server.
Invalid model name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToModelViaDomain(string, string, string, string, string, IDictionary)

Declaration

public virtual void ConnectToModelViaDomain(string directoryServer, string domain, string modelName, string userid, string password, IDictionary modelVariables)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	modelName	Specifies the name of a Host Integrator model.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Failure to locate Host Integrator domain server.
Invalid model name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSession(string, string)

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.

Declaration

public virtual void ConnectToSession(string server, string session)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	session	Specifies a Host Integrator session pool.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid session name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSession(string, string, IDictionary)

Declaration

public virtual void ConnectToSession(string server, string session, IDictionary modelVariables)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	session	Specifies a Host Integrator session pool.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid session name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSession(string, string, string, string)

Declaration

public virtual void ConnectToSession(string server, string session, string userid, string password)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	session	Specifies a Host Integrator session pool.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid session name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSession(string, string, string, string, IDictionary)

Declaration

public virtual void ConnectToSession(string server, string session, string userid, string password, IDictionary modelVariables)

Parameters

Type	Name	Description
string	server	Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
string	session	Specifies a Host Integrator session pool.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Host Integrator server is not running.
Invalid server name or IP address.
Invalid session name.
Invalid userID or password.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSessionViaDomain(string, string, string)

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.

Declaration

public virtual void ConnectToSessionViaDomain(string directoryServer, string domain, string session)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	session	Specifies a Host Integrator session pool.

Remarks

Reasons for failure include:

Unable to locate Host Integrator domain server.
Unable to locate AADS server.
Invalid session name.
Invalid userID or password.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSessionViaDomain(string, string, string, IDictionary)

Declaration

public virtual void ConnectToSessionViaDomain(string directoryServer, string domain, string session, IDictionary modelVariables)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	session	Specifies a Host Integrator session pool.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Unable to locate Host Integrator domain server.
Unable to locate AADS server.
Invalid session name.
Invalid userID or password.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSessionViaDomain(string, string, string, string, string)

Declaration

public virtual void ConnectToSessionViaDomain(string directoryServer, string domain, string session, string userid, string password)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	session	Specifies a Host Integrator session pool.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.

Remarks

Reasons for failure include:

Unable to locate Host Integrator domain server.
Unable to locate AADS server.
Invalid session name.
Invalid userID or password.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

ConnectToSessionViaDomain(string, string, string, string, string, IDictionary)

Declaration

public virtual void ConnectToSessionViaDomain(string directoryServer, string domain, string session, string userid, string password, IDictionary modelVariables)

Parameters

Type	Name	Description
string	directoryServer	Specifies a Host Integrator authentication and authorization directory server (AADS).
string	domain	Specifies a Host Integrator domain.
string	session	Specifies a Host Integrator session pool.
string	userid	Specifies a user ID to present to the Host Integrator server.
string	password	Specifies a password to present to the Host Integrator server.
IDictionary	modelVariables	Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Unable to locate Host Integrator domain server.
Unable to locate AADS server.
Invalid session name.
Invalid userID or password.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the client connection attempt fails
HostIntegratorTimeoutException	Thrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerException	Thrown if the server refuses a client connection attempt
HostIntegratorServerException	Thrown if the requested model or session is not available
HostIntegratorServerException	Thrown if the host connection does not succeed

Disconnect()

Disconnects from a Host Integrator server session.

Declaration

public virtual void Disconnect()

Remarks

Reasons for failure include:

No current session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

EnableTerminalAttributes()

Enables the availability of terminal attributes when retrieving attribute or field data from the Host Integrator server.

Declaration

public virtual void EnableTerminalAttributes()

Remarks

This method applies to subsequent GetAttributes or FetchRecords method calls during the current session. Attributes are only retrieved if they are enabled at run-time with this method call, and also enabled in the model file for the entity or recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

EnableTerminalAttributes(bool)

Enables the availability of terminal attributes when retrieving attribute or field data from the Host Integrator server.

Declaration

public virtual void EnableTerminalAttributes(bool enable)

Parameters

Type	Name	Description
bool	enable	Specifies whether terminal attributes are enabled.

Remarks

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

ExecuteSQLStatement(string)

Executes an SQL statement on a table defined in the model.

Declaration

public virtual DataSet ExecuteSQLStatement(string sqlStatement)

Parameters

Type	Name	Description
string	sqlStatement	Specifies the SQL statement to execute.

Returns

Type	Description
DataSet	This method returns a DataSet containing the results of the query. If no data are returned, this method returns an empty DataSet.

Remarks

Executes an SQL statement on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if the SQL statement cannot be resolved
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

ExecuteSQLStatement(string, int)

Executes an SQL statement on a table defined in the model.

Declaration

public virtual DataSet ExecuteSQLStatement(string sqlStatement, int maxRows)

Parameters

Type	Name	Description
string	sqlStatement	Specifies the SQL statement to execute.
int	maxRows	Specifies the maximum number of rows to return. A value of zero will return all rows.

Returns

Type	Description
DataSet	This method returns a DataSet containing the results of the query. If no data are returned, this method returns an empty DataSet.

Remarks

Executes an SQL statement on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if the SQL statement cannot be resolved
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

FetchRecords()

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords()

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records.

Remarks

The set of records returned begins with the first record following the current record. If the current record is before the first record in the recordset, searching starts with the first record. After a FetchRecords, the current record is the last record included in the returned set of records.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(IList)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(IList fieldNames)

Parameters

Type	Name	Description
IList	fieldNames	Specifies field names to fetch from the recordset.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If no fields match the fieldNames provided, an empty DataSet is returned.

Remarks

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if a reference is made to nonexistent fields
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(IList, string)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(IList fieldNames, string filterExpression)

Parameters

Type	Name	Description
IList	fieldNames	Specifies field names to fetch from the recordset.
string	filterExpression	Specifies an expression that qualifies the records to fetch. See the Remarks section for details.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If no fields match the fieldNames provided, or if the filterExpression eliminates all records, an empty DataSet is returned.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(int)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(int maxRows)

Parameters

Type	Name	Description
int	maxRows	Specifies the maximum number of rows of data to be returned. If maxRows is set to 0, no limit is imposed on the number of rows returned.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records.

Remarks

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(int, IList)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(int maxRows, IList fieldNames)

Parameters

Type	Name	Description
int	maxRows	Specifies the maximum number of rows of data to be returned. If maxRows is set to 0, no limit is imposed on the number of rows returned.
IList	fieldNames	Specifies field names to fetch from the recordset.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If no fields match the fieldNames provided, an empty DataSet is returned.

Remarks

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(int, IList, string)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(int maxRows, IList fieldNames, string filterExpression)

Parameters

Type	Name	Description
int	maxRows	Specifies the maximum number of rows of data to be returned. If maxRows is set to 0, no limit is imposed on the number of rows returned.
IList	fieldNames	Specifies field names to fetch from the recordset.
string	filterExpression	Specifies an expression that qualifies the records to fetch. See the Remarks section for details.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If no fields match the fieldNames provided, or if the filterExpression eliminates all records, an empty DataSet is returned.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(int, string)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(int maxRows, string filterExpression)

Parameters

Type	Name	Description
int	maxRows	Specifies the maximum number of rows of data to be returned. If maxRows is set to 0, no limit is imposed on the number of rows returned.
string	filterExpression	Specifies an expression that qualifies the records to fetch. See the Remarks section for details.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If the filterExpression eliminates all records, an empty DataSet is returned.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

FetchRecords(string)

Fetches data from the Host Integrator server for the current recordset of the current entity.

Declaration

public virtual DataSet FetchRecords(string filterExpression)

Parameters

Type	Name	Description
string	filterExpression	Specifies an expression that qualifies the records to fetch. See the Remarks section for details.

Returns

Type	Description
DataSet	This method returns a DataSet containing the requested records. If the filterExpression eliminates all records, an empty DataSet is returned.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

GetAttributeAtCursor()

Gets the name of the attribute at the current cursor position.

Declaration

public virtual string GetAttributeAtCursor()

Returns

Type	Description
string	This method returns the attribute name, or an empty string if the cursor is not currently within one of the defined entity attributes.

Remarks

Gets the name of the attribute at the current cursor position.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetAttributeLocations()

Gets locations for attributes of the current entity.

Declaration

public virtual IList GetAttributeLocations()

Returns

Type	Description
IList	This version of the GetAttributeLocations method (without parameters) returns a list of ElementLocation objects, for each attribute for the current entity.

Remarks

Gets locations for attributes of the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetAttributeLocations(IList)

Gets locations for attributes of the current entity.

Declaration

public virtual IList GetAttributeLocations(IList attributeNames)

Parameters

Type	Name	Description
IList	attributeNames	Specifies attribute names.

Returns

Type	Description
IList	This version of the GetAttributeLocations method returns a list of ElementLocation objects, for each attribute in the list of attribute names.

Remarks

Gets locations for attributes of the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetAttributeMetaData(string, string)

Gets metadata for the specified attribute and entity in the Host Integrator model.

Declaration

public virtual AttributeMetaData GetAttributeMetaData(string entityName, string attributeName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the Host Integrator model.
string	attributeName	Specifies an attribute in the specified entity.

Returns

Type	Description
AttributeMetaData	This method returns metadata about the specified attribute.

Remarks

Gets metadata for the specified attribute and entity in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity or attribute

GetAttributes()

Gets all attributes for the current entity that are not write-only.

Declaration

public virtual DataSet GetAttributes()

Returns

Type	Description
DataSet	This version of the GetAttributes method (without parameters) returns all attributes of the current entity.

Remarks

Gets attributes for the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetAttributes(IList)

Gets attributes for the current entity.

Declaration

public virtual DataSet GetAttributes(IList attributeNames)

Parameters

Type	Name	Description
IList	attributeNames	Specifies attributes to get from the entity. If attributeNames is null, getAttributes will return all attributes of the entity that are not write-only.

Returns

Type	Description
DataSet	This version of the GetAttributes method (without parameters) returns all attributes of the current entity.

Remarks

Gets attributes for the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetColumnMetaData(string, string)

Gets metadata for a table column in the Host Integrator model.

Declaration

public virtual ColumnMetaData GetColumnMetaData(string tableName, string columnName)

Parameters

Type	Name	Description
string	tableName	Specifies a table in the current host integrator model.
string	columnName	Specifies a column in the specified table.

Returns

Type	Description
ColumnMetaData	This method returns column metadata.

Remarks

Gets metadata for a table column in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent table or column

GetCurrentEntity()

Gets the name of the current entity in the Host Integrator model.

Declaration

public virtual string GetCurrentEntity()

Returns

Type	Description
string	This method returns the name of the current entity in the Host Integrator model.

Remarks

Gets the name of the current entity in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetCurrentRecord()

Get the current record

Declaration

public virtual DataSet GetCurrentRecord()

Returns

Type	Description
DataSet	the current record. If there is no current record, the method returns an empty Dataset.

GetCurrentRecordIndex()

Gets the index number of the current record in the current recordset.

Declaration

public virtual int GetCurrentRecordIndex()

Returns

Type	Description
int	This method returns the index of the current record in the current recordset.

Remarks

Gets the index number of the current record in the current recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

GetCurrentRecordSetName()

Gets the name of the current recordset.

Declaration

public virtual string GetCurrentRecordSetName()

Returns

Type	Description
string	This method returns the name of the current recordset in the Host Integrator model.

Remarks

Gets the name of the current recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

GetEntityAttributes(string)

Gets the names of the attributes for the specified entity in the Host Integrator model.

Declaration

public virtual IList GetEntityAttributes(string entityName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the Host Integrator model.

Returns

Type	Description
IList	This method returns the names of the attributes for the specified entity in the Host Integrator model.

Remarks

Reasons for failure include:

Server session not established.
Invalid entity name.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity

GetEntityDescription(string)

Gets the description for the specified entity in the Host Integrator model.

Declaration

public virtual string GetEntityDescription(string entityName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the current Host Integrator model.

Returns

Type	Description
string	This method returns the description for the specified entity.

Remarks

Gets the description for the specified entity in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity

GetEntityOperations(string)

Gets the names of the operations in the specified entity.

Declaration

public virtual IList GetEntityOperations(string entityName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the current Host Integrator model.

Returns

Type	Description
IList	This method returns the names of the operations in the specified entity.

Remarks

Reasons for failure include:

Server session not established.
Invalid entity name.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity

GetEntityRecordSets(string)

Gets the names of the recordsets in the specified entity.

Declaration

public virtual IList GetEntityRecordSets(string entityName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the current Host Integrator model.

Returns

Type	Description
IList	This method returns the names of the recordsets in the specified entity.

Remarks

Reasons for failure include:

Server session not established.
Invalid entity name.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity

GetFieldLocations()

Gets field locations for the current record in the current recordset in the current entity.

Declaration

public virtual IList GetFieldLocations()

Returns

Type	Description
IList	This version of the GetFieldLocations method returns all field locations in the current record.

Remarks

Gets field locations for the current record in the current recordset in the current entity.

Recordset fields are always linear regions.

This method is guaranteed to work correctly only when a record in the recordset is selected. If no record is selected:

For recordsets containing fixed records, the field locations returned are those for the first record in the recordset, based upon the information stored in the model.
For recordsets containing variable-length records, the information returned is not meaningful.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

GetFieldLocations(IList)

Gets field locations for the current record in the current recordset in the current entity.

Declaration

public virtual IList GetFieldLocations(IList fieldNames)

Parameters

Type	Name	Description
IList	fieldNames	Specifies fields for which locations are to be returned.

Returns

Type	Description
IList	This version of the GetFieldLocations method returns all field locations in the current record.

Remarks

Gets field locations for the current record in the current recordset in the current entity.

Recordset fields are always linear regions.

This method is guaranteed to work correctly only when a record in the recordset is selected. If no record is selected:

For recordsets containing fixed records, the field locations returned are those for the first record in the recordset, based upon the information stored in the model.
For recordsets containing variable-length records, the information returned is not meaningful.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

GetFieldMetaData(string, string, string)

Gets metadata for the specified field in the specified recordset and entity in the Host Integrator model.

Declaration

public virtual FieldMetaData GetFieldMetaData(string entityName, string recordSetName, string fieldName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the Host Integrator model.
string	recordSetName	Specifies a recordset in the specified entity.
string	fieldName	Specifies a field in the specified recordset.

Returns

Type	Description
FieldMetaData	This method returns metadata for the specified field.

Remarks

Gets metadata for the specified field in the specified recordset and entity in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity, recordset, or field
HostIntegratorModelDefException	Thrown if there is no current recordset

GetHomeEntityName()

Gets the name of the home entity for the current Host Integrator model.

Declaration

public virtual string GetHomeEntityName()

Returns

Type	Description
string	This method returns the name of the home entity. If there is no home entity (for example, because the model contains only connection information), this method returns a null.

Remarks

Gets the name of the home entity for the current Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

GetLastRequestID()

Gets an identifier for the most recent request performed against the current Host Integrator server session.

Declaration

public virtual int GetLastRequestID()

Returns

Type	Description
int	This method returns an integer identifying the most recent request performed against the current Host Integrator server session.

Remarks

If a server request has not yet been performed in the current session, GetLastRequestID returns 0.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetLocale()

Gets the locale for the current session.

Declaration

public virtual string GetLocale()

Returns

Type	Description
string	This method returns the locale for the current session.

Remarks

Gets the locale for the current session.

GetLoggingLevel()

Gets the logging level for the current Host Integrator session.

Declaration

public virtual LoggingLevel GetLoggingLevel()

Returns

Type	Description
LoggingLevel	The value returned is a member of the LoggingLevel enumeration.

Remarks

Gets the logging level for the current Host Integrator session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetMajorVersion()

Gets the major version number for the locally installed Verastream software.

Declaration

public virtual int GetMajorVersion()

Returns

Type	Description
int	This method returns the major version number for Verastream.

Remarks

The major version is the part of the complete version number that precedes the first period. So, for example, if the complete version number is "5.6", the major version portion is "5".

GetMinorVersion()

Gets the minor version number for the locally installed Verastream software.

Declaration

public virtual int GetMinorVersion()

Returns

Type	Description
int	This method returns the minor version number for Verastream.

Remarks

The minor version is the part of the complete version number that follows the first period. So, for example, if the complete version number is "5.6", the minor version portion is "6".

GetModelEntities()

Gets the names of the entities in the current Host Integrator model.

Declaration

public virtual IList GetModelEntities()

Returns

Type	Description
IList	This method returns the names of the entities in the current Host Integrator model.

Remarks

Reasons for failure include:

Server session not established.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

GetModelVariableNames()

Gets the names of all non-hidden model variables in the Host Integrator model.

Declaration

public virtual IList GetModelVariableNames()

Returns

Type	Description
IList	This method returns the names of all non-hidden model variables in the Host Integrator model.

Remarks

Reasons for failure include:

Server session not established.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

GetModelVariables()

Gets the values of all non-hidden model variables in the current Host Integrator model.

Declaration

public virtual IDictionary GetModelVariables()

Returns

Type	Description
IDictionary	This method returns the values of all non-hidden model variables in the Host Integrator model.

Remarks

Reasons for failure include:

Server session not established.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetOperationMetaData(string, string)

Gets metadata for an operation in the current Host Integrator model.

Declaration

public virtual OperationMetaData GetOperationMetaData(string entityName, string operationName)

Parameters

Type	Name	Description
string	entityName	Specifies the name of an entity in the Host Integrator model.
string	operationName	Specifies the name of an operation associated with the specified entity.

Returns

Type	Description
OperationMetaData	This method returns metadata for an operation in the current Host Integrator model.

Remarks

Gets metadata for an operation in the current Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity or operation

GetPatternLocations()

Gets the locations for all patterns for the current entity.

Declaration

public virtual IList GetPatternLocations()

Returns

Type	Description
IList	This version of the GetPatternLocations method (without parameters) returns a list of ElementLocation lobject for all patterns defined for the current entity.

Remarks

Gets the locations for all patterns for the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetPatternLocations(IList)

Gets the locations for the specified patterns for the current entity.

Declaration

public virtual IList GetPatternLocations(IList patternNames)

Parameters

Type	Name	Description
IList	patternNames	Specifies the names of the patterns for which locations are to be returned.

Returns

Type	Description
IList	This version of the GetPatternLocations method (with a patternName parameter) returns locations for the specified patterns for the current entity.

Remarks

Gets the locations for the specified patterns for the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent pattern

GetProcedureMetaData(string, string)

Gets metadata for a table procedure in the Host Integrator model.

Declaration

public virtual ProcedureMetaData GetProcedureMetaData(string tableName, string procedureName)

Parameters

Type	Name	Description
string	tableName	Specifies a table in the current Host Integrator model.
string	procedureName	Specifies a procedure in the specified table.

Returns

Type	Description
ProcedureMetaData	This method returns metadata for the specified table procedure.

Remarks

Gets metadata for a table procedure in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent table or procedure

GetRecordSetLocations()

Gets the locations for all recordsets in the current entity.

Declaration

public virtual IList GetRecordSetLocations()

Returns

Type	Description
IList	This version of the GetRecordSetLocations method (without parameters) returns locations for all recordsets in the current entity.

Remarks

Gets the locations for all recordsets in the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetRecordSetLocations(IList)

Gets the locations for the specified recordsets in the current entity.

Declaration

public virtual IList GetRecordSetLocations(IList recordSetNames)

Parameters

Type	Name	Description
IList	recordSetNames	Specifies the names of the recordsets for which locations are to be returned.

Returns

Type	Description
IList	This version of the GetRecordSetLocations method (with a recordSetNames parameter) returns locations for the specified recordsets in the current entity.

Remarks

Gets the locations for the specified recordsets in the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent recordset

GetRecordSetMetaData(string, string)

Gets metadata for a recordset in the specified entity.

Declaration

public virtual RecordSetMetaData GetRecordSetMetaData(string entityName, string recordSetName)

Parameters

Type	Name	Description
string	entityName	Specifies an entity in the Host Integrator model.
string	recordSetName	Specifies a recordset in the specified entity.

Returns

Type	Description
RecordSetMetaData	This method returns metadata for the specified recordset.

Remarks

Gets metadata for a recordset in the specified entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent entity or recordset
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent recordset

GetSessionID()

Gets an identifier for the current Host Integrator session.

Declaration

public virtual int GetSessionID()

Returns

Type	Description
int	This method returns an integer identifying the current Host Integrator session.

Remarks

Gets an identifier for the current Host Integrator session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetStringAtOffset(int, int)

Gets a string of the specified length, starting at the specified offset, from the current entity.

Declaration

public virtual string GetStringAtOffset(int offset, int length)

Parameters

Type	Name	Description
int	offset	Specifies an offset from the start of the screen buffer.
int	length	Specifies the length of the string to be returned.

Returns

Type	Description
string	This method returns a string of the specified length, starting at the specified offset, from the current entity.

Remarks

Reasons for failure include:

Server session not established.
Invalid offset.
Invalid length.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if the offset or length values are out of range

GetStringAtRowColumn(int, int, int, int)

Gets a string from a rectangular region of the current entity.

Declaration

public virtual string GetStringAtRowColumn(int topRow, int leftColumn, int numRows, int numColumns)

Parameters

Type	Name	Description
int	topRow	Specifies the starting row for the selection.
int	leftColumn	Specifies the starting column for the selection.
int	numRows	Specifies the number of rows in the selection.
int	numColumns	Specifies the number of columns in the selection.

Returns

Type	Description
string	This method returns a string containing the contents of a rectangular region of the current entity.

Remarks

Gets a string from a rectangular region of the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown a value is out of range

GetTableColumns(string)

Gets the column names for a table in the Host Integrator model.

Declaration

public virtual IList GetTableColumns(string tableName)

Parameters

Type	Name	Description
string	tableName	Specifies the name of a table in the Host Integrator model.

Returns

Type	Description
IList	This method returns the column names for the specified table.

Remarks

Gets the column names for a table in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent table

GetTableDescription(string)

Gets the description for a table in the Host Integrator model.

Declaration

public virtual string GetTableDescription(string tableName)

Parameters

Type	Name	Description
string	tableName	Specifies the name of a table in the Host Integrator model.

Returns

Type	Description
string	This method returns the name of a table in the Host Integrator model.

Remarks

Gets the description for a table in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent table

GetTableNames()

Gets the names of all tables in the Host Integrator model.

Declaration

public virtual IList GetTableNames()

Returns

Type	Description
IList	This method returns the names of all tables in the Host Integrator model.

Remarks

Gets the names of all tables in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected

GetTableProcedures(string)

Gets the procedure names for a table in the Host Integrator model.

Declaration

public virtual IList GetTableProcedures(string tableName)

Parameters

Type	Name	Description
string	tableName	Specifies the name of a table in the Host Integrator model.

Returns

Type	Description
IList	This method returns the procedure names for a table in the Host Integrator model.

Remarks

Gets the procedure names for a table in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent table

GetTerminalFieldAtCursor()

Gets a TerminalField object that contains information about the terminal field at the current cursor position on the Host Integrator screen.

Declaration

public virtual TerminalField GetTerminalFieldAtCursor()

Returns

Type	Description
TerminalField	This method returns a TerminalField object that contains information about the terminal field at the current cursor position.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

GetVMRFilePrefix()

Gets the VMR file prefix.

Declaration

public virtual string GetVMRFilePrefix()

Returns

Type	Description
string	The VMR file prefix.

GetVariableMetaData(string)

Gets metadata for a model variable in the Host Integrator model.

Declaration

public virtual VariableMetaData GetVariableMetaData(string variableName)

Parameters

Type	Name	Description
string	variableName	Specifies the name of a variable in the Host Integrator model.

Returns

Type	Description
VariableMetaData	This method returns metadata for the specified variable.

Remarks

Gets metadata for a model variable in the Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent variable

GetVersionString()

Gets the version string for the Verastream .NET connector. This string is of the form majorVersion.minorVersion.

Declaration

public virtual string GetVersionString()

Returns

Type	Description
string	This method returns the version string for the Verastream .NET connector.

Remarks

Gets the version string for the Verastream .NET connector. This string is of the form majorVersion.minorVersion.

InsertRecord(IDictionary)

Performs an insert operation for the current recordset.

Declaration

public virtual void InsertRecord(IDictionary record)

Parameters

Type	Name	Description
IDictionary	record	Specifies a set of name-value pairs (each representing a record field) to insert into the entity recordset.

Remarks

Performs an insert operation for the current recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if the insert operation fails.
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field

InsertRecords(DataSet)

Performs the insert operation for the current recordset multiple times.

Declaration

public virtual void InsertRecords(DataSet records)

Parameters

Type	Name	Description
DataSet	records	Specifies a set of name-value pairs (each representing a record field) to insert into the recordset.

Remarks

This method sends the complete list of records to insert to the server at one time, making insertion of multiple records more efficient than with the InsertRecord(IDictionary) method.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if the insert operation fails.
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field

InsertStringAtCursor(string)

Inserts the specified string into the current entity on the Host Integrator server starting at the current cursor position.

Declaration

public virtual void InsertStringAtCursor(string str)

Parameters

Type	Name	Description
string	str	Specifies the string to insert.

Remarks

Reasons for failure include:

Server session not established.
Invalid string.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorTerminalException	Thrown if the insert fails

InsertStringAtOffset(string, int)

Inserts a string into the current entity on the Host Integrator server starting at an offset.

Declaration

public virtual void InsertStringAtOffset(string str, int offset)

Parameters

Type	Name	Description
string	str	Specifies the string to insert.
int	offset	Specifies the offset from the start of the screen buffer.

Remarks

Inserts a string into the current entity on the Host Integrator server starting at an offset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorTerminalException	Thrown if the insert fails
HostIntegratorServerException	Thrown if a row or column value is out of range
HostIntegratorConnectorException	Thrown if an argument is invalid

InsertStringAtRowColumn(string, int, int)

Inserts a string into the current entity on the Host Integrator server starting at the given row and column location.

Declaration

public virtual void InsertStringAtRowColumn(string str, int rowNum, int columnNum)

Parameters

Type	Name	Description
string	str	Specifies the string to insert.
int	rowNum	Specifies the row number of the starting location for insertion on the entity.
int	columnNum	Specifies the column number of the starting location for insertion on the entity.

Remarks

Inserts a string into the current entity on the Host Integrator server starting at the given row and column location.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorTerminalException	Thrown if the insert fails
HostIntegratorServerException	Thrown if a row or column value is out of range
HostIntegratorConnectorException	Thrown if an argument is invalid

MoveCurrentRecordIndex(ScrollMovement)

Moves the current record index to a new position in the current recordset.

Declaration

public virtual void MoveCurrentRecordIndex(ScrollMovement movement)

Parameters

Type	Name	Description
ScrollMovement	movement	The value must be a member of the ScrollMovement enumeration.

Remarks

Moves the current record index to a new position in the current recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset
HostIntegratorModelDefException	Thrown if the requested scroll operation is not defined on the current recordset
HostIntegratorTerminalException	Thrown if the operation fails or is not permitted

NextRecord()

Returns the next record in the current recordset.

Declaration

public virtual DataSet NextRecord()

Returns

Type	Description
DataSet	This method returns the next record in the current recordset.

Remarks

If there are no more records in the recordset, this method throws an exception: "Caught VHI Exception in GetItem(); ElementDoesNotExist". (This does not happen in Java.)

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if there is no current recordset
HostIntegratorConnectorException	Thrown if there are no more records
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

NextRecord(string)

Finds and returns a record in the current recordset using a filter expression.

Declaration

public virtual DataSet NextRecord(string filterExpression)

Parameters

Type	Name	Description
string	filterExpression	Specifies an expression that qualifies the records to fetch. See the Remarks section for details.

Returns

Type	Description
DataSet	This method returns the next record in the current recordset matching the filter. Searching starts with the record following the current record. If the current record is before the first record in the recordset, searching starts with the first record.

Remarks

If there are no more records in the recordset, or no records that match the filter expression, this method throws an exception: "Caught VHI Exception in GetItem(); ElementDoesNotExist". (This does not happen in Java.)

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorModelDefException	Thrown if there is no current recordset
HostIntegratorConnectorException	Thrown if there are no more records
HostIntegratorConnectorException	Thrown if there are no records matching the filter expression
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

PerformAidKey(AidKey)

Enters an aid key (for example, a Program Function key) into the current Host Integrator server session.

Declaration

public virtual void PerformAidKey(AidKey key)

Parameters

Type	Name	Description
AidKey	key	Specifies any of the terminal key constants defined in the AidKey enumeration.

Remarks

Enters an aid key (for example, a Program Function key) into the current Host Integrator server session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

PerformEntityOperation(string)

Performs an operation on the current entity.

Declaration

public virtual void PerformEntityOperation(string operationName)

Parameters

Type	Name	Description
string	operationName	Specifies the name of the operation to perform.

Remarks

Reasons for failure include:

Server session not established.
Invalid operation.
Session is already connected to a Host Integrator server.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent operation
HostIntegratorTerminalException	Thrown if the operation fails

PerformTableProcedure(string, string, IDictionary)

Performs a procedure on a table defined in the model.

Declaration

public void PerformTableProcedure(string tableName, string procedureName, IDictionary inputValues)

Parameters

Type	Name	Description
string	tableName	Specifies the name of the table on which to perform the procedure.
string	procedureName	Specifies the name of the table procedure to perform.
IDictionary	inputValues	Specifies a set of column name-value pairs to input.

Remarks

Performs an INSERT procedure on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if an error occurs while performing the procedure

PerformTableProcedure(string, string, IDictionary, bool)

Performs a SELECT or a DELETE procedure on a table defined in the model.

Declaration

public DataSet PerformTableProcedure(string tableName, string procedureName, IDictionary filterValues, bool filterIsCaseSensitive)

Parameters

Type	Name	Description
string	tableName	Specifies the name of the table on which to perform the procedure.
string	procedureName	Specifies the name of the table procedure to perform.
IDictionary	filterValues	Specifies a set of filter column name-value pairs to use.
bool	filterIsCaseSensitive	Specifies whether the filter comparison should be case sensitive.

Returns

Type	Description
DataSet	This method returns the result of a SELECT procedure. If no data match the specified conditions, this method returns an empty DataSet.

Remarks

Performs a SELECT procedure on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if an error occurs while performing the procedure

PerformTableProcedure(string, string, IDictionary, bool, IList, int)

Performs a SELECT procedure on a table defined in the model.

Declaration

public DataSet PerformTableProcedure(string tableName, string procedureName, IDictionary filterValues, bool filterIsCaseSensitive, IList outputColumnNames, int maxRows)

Parameters

Type	Name	Description
string	tableName	Specifies the name of the table on which to perform the procedure.
string	procedureName	Specifies the name of the table procedure to perform.
IDictionary	filterValues	Specifies a set of filter column name-value pairs to use.
bool	filterIsCaseSensitive	Specifies whether the filter comparison should be case sensitive.
IList	outputColumnNames	Specifies the names of the columns to return.
int	maxRows	Specifies the maximum number of rows to return. If maxRows is set to 0, no limit is imposed on the number of rows returned.

Returns

Type	Description
DataSet	This method returns the result of a SELECT procedure. If no data match the specified conditions, this method returns an empty DataSet.

Remarks

Performs a SELECT procedure on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if an error occurs while performing the procedure

PerformTableProcedure(string, string, IDictionary, IDictionary, bool)

Performs an UPDATE procedure on a table defined in the model.

Declaration

public void PerformTableProcedure(string tableName, string procedureName, IDictionary inputValues, IDictionary filterValues, bool filterIsCaseSensitive)

Parameters

Type	Name	Description
string	tableName	Specifies the name of the table on which to perform the procedure.
string	procedureName	Specifies the name of the table procedure to perform.
IDictionary	inputValues	Specifies a set of column name-value pairs to input.
IDictionary	filterValues	Specifies a set of filter column name-value pairs to use.
bool	filterIsCaseSensitive	Specifies whether the filter comparison should be case sensitive.

Remarks

Performs an UPDATE procedure on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if an error occurs while performing the procedure

PerformTableProcedure(string, string, IDictionary, IDictionary, bool, IList, int)

Performs a procedure on a table defined in the model.

Declaration

public DataSet PerformTableProcedure(string tableName, string procedureName, IDictionary inputValues, IDictionary filterValues, bool filterIsCaseSensitive, IList outputColumnNames, int maxRows)

Parameters

Type	Name	Description
string	tableName	Specifies the name of the table on which to perform the procedure.
string	procedureName	Specifies the name of the table procedure to perform.
IDictionary	inputValues	Specifies a set of column name-value pairs to input.
IDictionary	filterValues	Specifies a set of filter column name-value pairs to use.
bool	filterIsCaseSensitive	Specifies whether the filter comparison should be case sensitive.
IList	outputColumnNames	Specifies the names of the columns to return.
int	maxRows	Specifies the maximum number of rows to return. If maxRows is set to 0, no limit is imposed on the number of rows returned.

Returns

Type	Description
DataSet	This method returns the result of the table procedure, if applicable. If no data match the specified conditions, this method returns an empty DataSet.

Remarks

Performs a table procedure on a table defined in the model.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if an error occurs while performing the procedure

ProcessString(string)

Calls the ProcessString event handler on the server.

Declaration

public virtual string ProcessString(string inStr)

Parameters

Type	Name	Description
string	inStr	Specifies the input string to be processed.

Returns

Type	Description
string	This method returns a string containing the results returned by the ProcessString event handler.

Remarks

Returns a string containing the results returned by the ProcessString event handler.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorServerException	Thrown if the ProcessString method is not supported for the current model, or an execution error occurs

RequireSecureConnection(bool)

This method is kept for backwards compatibility. Connections to a Host Integrator Server are always encrypted.

Declaration

public virtual void RequireSecureConnection(bool require)

Parameters

Type	Name	Description
bool	require	Ignored.

Remarks

This method is kept for backwards compatibility. Connections to a Host Integrator Server are always encrypted.

ResumeConnection(string)

Resumes the execution of a currently suspended Host Integrator server session.

Declaration

public virtual void ResumeConnection(string connectionToken)

Parameters

Type	Name	Description
string	connectionToken	Specifies the token received from the SuspendConnection(int) method.

Remarks

If the requested session is already running, this method does nothing.

Reasons for failure include:

Server session not established.
Server session no longer present.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if already connected
HostIntegratorChannelException	Thrown if the attempt to resume the connection fails

SelectCurrentRecord()

Selects the current record in the current recordset.

Declaration

public virtual void SelectCurrentRecord()

Remarks

Selects the current record in the current recordset, by performing the user-defined selection operation.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset

SelectRecordByFilter(string)

Finds a record in the current recordset using a filter expression, and perform a selection operation.

Declaration

public virtual bool SelectRecordByFilter(string filterExpression)

Parameters

Type	Name	Description
string	filterExpression	Specifies an expression that qualifies the record to find. See the Remarks section for details.

Returns

Type	Description
bool	This method returns True if the selection succeeds, or False if the method fails to find a record to select.

Remarks

Searching starts with the record following the current record. If the current record is before the first record in the recordset, searching starts with the first record.

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorModelDefException	Thrown if there is no current recordset
HostIntegratorTerminalException	Thrown if there is an execution error

SelectRecordByIndex(int)

Performs its selection operation on a record in the current recordset. The record to select is determined by the specified index number.

Declaration

public virtual bool SelectRecordByIndex(int index)

Parameters

Type	Name	Description
int	index	Specifies the index of the record to select.

Returns

Type	Description
bool	This method returns True if the selection succeeds, or False if no record can be selected.

Remarks

Performs its selection operation on a record in the current recordset. The record to select is determined by the specified index number.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if there is no current recordset
HostIntegratorTerminalException	Thrown if there is an execution error

SetAttributes(IDictionary)

Sets the attributes for the current entity.

Declaration

public virtual void SetAttributes(IDictionary attributes)

Parameters

Type	Name	Description
IDictionary	attributes	Specifies attributes for the current entity, using name-value pairs.

Remarks

SetAttributes does not need to specify all attributes for the entity, but it should specify all required attributes.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent attribute
HostIntegratorTerminalException	Thrown if there is an execution error

SetAttributes(DataSet)

Sets the attributes for the current entity.

Declaration

public virtual void SetAttributes(DataSet attributes)

Parameters

Type	Name	Description
DataSet	attributes	Specifies attributes for the current entity, using name-value pairs.

Remarks

SetAttributes does not need to specify all attributes for the entity, but it should specify all required attributes.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent attribute
HostIntegratorTerminalException	Thrown if there is an execution error

SetAttributesDelayed(IDictionary, string)

Sets the attributes for the specified entity. Attributes are not actually set until the entity is reached.

Declaration

public virtual void SetAttributesDelayed(IDictionary attributes, string entityName)

Parameters

Type	Name	Description
IDictionary	attributes	Specifies attributes for the current entity, using name-value pairs.
string	entityName	Specifies the name of an entity in the current Host Integrator model.

Remarks

SetAttributesDelayed does not need to specify all attributes for the specified entity, but it should specify all required attributes.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent attribute
HostIntegratorTerminalException	Thrown if there is an execution error

SetAttributesDelayed(DataSet, string)

Sets the attributes for the specified entity. Attributes are not actually set until the entity is reached.

Declaration

public virtual void SetAttributesDelayed(DataSet attributes, string entityName)

Parameters

Type	Name	Description
DataSet	attributes	Specifies attributes for the current entity, using name-value pairs.
string	entityName	Specifies the name of an entity in the current Host Integrator model.

Remarks

SetAttributesDelayed does not need to specify all attributes for the specified entity, but it should specify all required attributes.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown when client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent attribute
HostIntegratorTerminalException	Thrown if there is an execution error

SetCurrentEntity(string)

Sets the current entity.

Declaration

public virtual void SetCurrentEntity(string entityName)

Parameters

Type	Name	Description
string	entityName	Specifies the name of an entity in the current Host Integrator model.

Remarks

This method will traverse to a particular screen in the host application.

Reasons for failure include:

Server session not established.
Invalid entity name.
No traversal path to entity.

Exceptions

Type	Condition
HostIntegratorModelDefException	Thrown if the entity name is not found in the model
HostIntegratorTerminalException	Thrown if the navigation fails
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

SetCurrentRecordIndex(int)

Sets the current record in the current recordset, using the record's index number.

Declaration

public virtual void SetCurrentRecordIndex(int index)

Parameters

Type	Name	Description
int	index	Specifies the index of the record to make current.

Remarks

Use -1 as the index to force the host's current record to match Verastream's current record. This is only appropriate if you intend to bypass the model to interact directly with the host (for example, by sending a terminal key).

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorTerminalException	Thrown if the index value is out of range
HostIntegratorModelDefException	Thrown if the action fails because of an undefined scroll operation

SetCurrentRecordSetByName(string)

Sets the current recordset, by name.

Declaration

public virtual void SetCurrentRecordSetByName(string name)

Parameters

Type	Name	Description
string	name	Specifies the name of a recordset in the current entity.

Remarks

This method is only relevant if there is more than one recordset in the current entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent recordset

SetLocale(string)

Sets the locale for the current session.

Declaration

public virtual void SetLocale(string locale)

Parameters

Type	Name	Description
string	locale	Specifies a valid locale.

Remarks

Sets the locale for the current session.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if locale is null

SetLoggingLevel(LoggingLevel)

Sets the logging level for the current Host Integrator session.

Declaration

public virtual void SetLoggingLevel(LoggingLevel loggingLevel)

Parameters

Type	Name	Description
LoggingLevel	loggingLevel	Specifies a logging level. The specified value must be a member of the LoggingLevel enumeration.

Remarks

The logging level you set with SetLoggingLevel overrides the global logging level for the server and lasts until you change it again or until disconnection. This is intended primarily for debugging, allowing you to log a larger class of messages for a single session without raising the global logging level for the Host Integrator server. You cannot use SetLoggingLevel to set the logging level lower than the server's logging level configuration.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

SetModelVariables(IDictionary)

Sets the values of variables in the current Host Integrator model.

Declaration

public virtual void SetModelVariables(IDictionary variables)

Parameters

Type	Name	Description
IDictionary	variables	Specifies a set of name-value pairs.

Remarks

Reasons for failure include:

Server session not established.
Invalid variable name.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent variable
HostIntegratorModelDefException	Thrown if an attempt is made to change the value of a variable that is not writeable

SetVMRFilePrefix(string)

Sets the VMR file prefix.

Declaration

public virtual void SetVMRFilePrefix(string prefix)

Parameters

Type	Name	Description
string	prefix	the VMR file prefix.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

SuspendConnection(int)

Suspends the execution of a currently running Host Integrator server session.

Declaration

public virtual string SuspendConnection(int timeout)

Parameters

Type	Name	Description
int	timeout	Specifies how many minutes can elapse before the suspended session is automatically terminated.

Returns

Type	Description
string	This method returns the connection token for this session, which can then be used with the ResumeConnection(string) method to re-establish the connection.

Remarks

On successful suspension, SuspendConnection returns a token to be used when resuming the session. If the current session is already suspended, this method does nothing.

Reasons for failure include:

Server session not established.
Current server session cannot be suspended.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if not connected
HostIntegratorException	Thrown if the connection is for metadata only

UpdateCurrentRecord(IDictionary)

Sets the values for the current record in the current recordset.

Declaration

public virtual void UpdateCurrentRecord(IDictionary record)

Parameters

Type	Name	Description
IDictionary	record	Specifies one or more name-value pairs to be updated.

Remarks

Sets the values for the current record in the current recordset.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorTerminalException	Thrown if there is an execution error

UpdateCurrentRecord(DataSet)

Sets the values for the current record in the current recordset.

Declaration

public virtual void UpdateCurrentRecord(DataSet record)

Parameters

Type	Name	Description
DataSet	record	Specifies one or more name-value pairs to be updated.

Remarks

Sets the values for the current record in the current recordset.

UpdateRecordByFilter(IDictionary, string)

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.

Declaration

public virtual bool UpdateRecordByFilter(IDictionary record, string filterExpression)

Parameters

Type	Name	Description
IDictionary	record	Specifes one or more name-value pairs for the record elements to be updated.
string	filterExpression	Specifies an expression that qualifies the records to be updated. See the Remarks section for details.

Returns

Type	Description
bool	This method returns True if a record is found to update and the Host Integrator server performs the record update, and False otherwise.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorServerException	Thrown if the table does not support updates

UpdateRecordByFilter(DataSet, string)

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.

Declaration

public virtual bool UpdateRecordByFilter(DataSet record, string filterExpression)

Parameters

Type	Name	Description
DataSet	record	Specifes one or more name-value pairs for the record elements to be updated.
string	filterExpression	Specifies an expression that qualifies the records to be updated. See the Remarks section for details.

Returns

Type	Description
bool	This method returns True if a record is found to update and the Host Integrator server performs the record update, and False otherwise.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorTerminalException	Thrown if there is an execution error
HostIntegratorServerException	Thrown if the table does not support updates

UpdateRecordByIndex(IDictionary, int)

Changes the values of a record in the current recordset. The record to change is determined by the specified index number.

Declaration

public virtual bool UpdateRecordByIndex(IDictionary record, int index)

Parameters

Type	Name	Description
IDictionary	record	Specifes one or more name-value pairs for the record elements to be updated.
int	index	Specifies the index of the record to update.

Returns

Type	Description
bool	This method returns True if the Host Integrator server is able to perform the record update, or False otherwise.

Remarks

Changes the values of a record in the current recordset. The record to change is determined by the specified index number.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorTerminalException	Thrown if there is an execution error

UpdateRecordByIndex(DataSet, int)

Changes the values of a record in the current recordset. The record to change is determined by the specified index number.

Declaration

public virtual bool UpdateRecordByIndex(DataSet record, int index)

Parameters

Type	Name	Description
DataSet	record	Specifes one or more name-value pairs for the record elements to be updated.
int	index	Specifies the index of the record to update.

Returns

Type	Description
bool	This method returns True if the Host Integrator server is able to perform the record update, or False otherwise.

Remarks

Changes the values of a record in the current recordset. The record to change is determined by the specified index number.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorTerminalException	Thrown if there is an execution error

UpdateRecords(IDictionary, string)

Updates the values of records in the current recordset, after the current record, that satisfy the specified filter expression.

Declaration

public virtual int UpdateRecords(IDictionary record, string filterExpression)

Parameters

Type	Name	Description
IDictionary	record	Specifes one or more name-value pairs for the record elements to be updated.
string	filterExpression	Specifies an expression that qualifies the records to be updated. See the Remarks section for details.

Returns

Type	Description
int	This method returns the number of records updated.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorTerminalException	Thrown if there is an execution error

UpdateRecords(DataSet, string)

Updates the values of records in the current recordset, after the current record, that satisfy the specified filter expression.

Declaration

public virtual int UpdateRecords(DataSet record, string filterExpression)

Parameters

Type	Name	Description
DataSet	record	Specifes one or more name-value pairs for the record elements to be updated.
string	filterExpression	Specifies an expression that qualifies the records to be updated. See the Remarks section for details.

Returns

Type	Description
int	This method returns the number of records updated.

Remarks

Using Filter Expressions

Some of the methods in the .NET connector allow you to use filter expressions when fetching records from a recordset. The syntax you can use to build filter expressions is:

condition_statement=condition_expression

You can use expressions on both the left and right sides of the condition statement. Be sure to enclose data in quotation marks.

Condition Expressions

AND	condition_expression AND condition_expression
OR	condition_expression OR condition_expression
NOT	NOT condition_expression
Equal to	value_expression = value_expression
Equal to (case insensitive)	value_expression =* value_expression
Not equal to	value_expression <> value_expression
Less than	value_expression < value_expression
Greater than	value_expression > value_expression
Less than or equal to	value_expression <= value_expression
Greater than or equal to	value_expression >= value_expression ( ) (multiple condition_expressions)

Value Expressions

A value expression can take any of the following:

Variable (variables.variablename)
Attribute (attribute name)
Field (recordset.recordsetfield)
String
Integer
Floating point number

Filter Expression Examples

This example returns all records in the patients recordset that are not "Smith":

patients.lastname  <> "Smith"

This example returns the exact same set of records as the preceding example:

NOT (patients.lastname = "Smith")

This example returns all records in the SearchResults recordset with the last name "Smith" and first name "Steven":

(SearchResults.LastName = "Smith") and (SearchResults.FirstName =* "Steven")

This example returns all fields in the AccountNumbers recordset greater than or equal to 10000 and less than or equal to 20000:

(AccountNumbers.Accounts >= 10000) and (AccountNumbers.Accounts <= 20000)

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if the filter expression is not valid
HostIntegratorModelDefException	Thrown if a reference is made to a nonexistent field
HostIntegratorTerminalException	Thrown if there is an execution error

WaitForCondition(int, string)

Waits for a condition to be fulfilled.

Declaration

public virtual void WaitForCondition(int timeout, string entityName)

Parameters

Type	Name	Description
int	timeout	Specifies a timeout period, in seconds.
string	entityName	Name of entity to wait for.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if the conditional expression is not valid
HostIntegratorServerException	Thrown if the event times out

WaitForCondition(int, string, string)

Waits for a condition to be fulfilled.

Declaration

public virtual void WaitForCondition(int timeout, string expression, string entityName)

Parameters

Type	Name	Description
int	timeout	Specifies a timeout period, in seconds.
string	expression	Conditional expression.
string	entityName	Specifies the name of an entity in the current Host Integrator model.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorException	Thrown if the connection is for metadata only
HostIntegratorModelDefException	Thrown if the conditional expression is not valid
HostIntegratorServerException	Thrown if the event times out

WaitForCursor(int, int, int)

Waits for the presence of the terminal cursor at the specified terminal screen coordinates.

Declaration

public virtual void WaitForCursor(int rowNum, int columnNum, int timeout)

Parameters

Type	Name	Description
int	rowNum	Specifies a row number in the terminal screen.
int	columnNum	Specifies a column number in the terminal screen.
int	timeout	Specifies a timeout period (in seconds). An exception is thrown if the timeout period elapses without the cursor arriving at the specified coordinates.

Remarks

Waits for the presence of the terminal cursor at the specified terminal screen coordinates.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorServerException	Thrown if the event times out
HostIntegratorConnectorException	Thrown an argument is invalid

WaitForEntityChange(string, int)

Waits for the recognition of any entity other than the specified entity.

Declaration

[Obsolete("This method has been deprecated.  It can result in a race condition.")]
public virtual void WaitForEntityChange(string entityName, int timeout)

Parameters

Type	Name	Description
string	entityName	Specifies the entity that cannot satisfy the entity change condition--typically the entity that is current when WaitForEntityChange is called.
int	timeout	Specifies a timeout period (in seconds). An exception is thrown if the timeout period elapses without an entity other than the specified entity being recognized.

Remarks

Waits for the recognition of any entity other than the specified entity.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorServerException	Thrown if the event times out

WaitForString(string, int, int, int)

Waits for the presence of the specified string starting at the specified screen coordinates.

Declaration

public virtual void WaitForString(string str, int rowNum, int columnNum, int timeout)

Parameters

Type	Name	Description
string	str	Specifies the string to wait for.
int	rowNum	Specifies the row where the string is to appear (use -1 to designate any row).
int	columnNum	Specifies the column where the string is to appear (use -1 to designate any column).
int	timeout	Specifies a timeout period (in seconds). An exception is thrown if the timeout period elapses before the specified string appears at the specified screen location.

Remarks

Waits for the presence of the specified string starting at the specified screen coordinates.

Exceptions

Type	Condition
HostIntegratorServerException	Thrown if the event times out
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorException	Thrown if the connection is for metadata only

WaitForStringRelCursor(string, int, int, int)

Waits for the presence of a string at a screen location relative to the current terminal screen cursor.

Declaration

public virtual void WaitForStringRelCursor(string str, int rowOffset, int columnOffset, int timeout)

Parameters

Type	Name	Description
string	str	Specifies the string to wait for.
int	rowOffset	Specifies the starting screen row for the string relative to current cursor row.
int	columnOffset	Specifies the starting screen column for the string relative to current cursor column.
int	timeout	Specifies a timeout period (in seconds). An exception is thrown if the timeout period elapses before the specified string appears at the specified screen location.

Remarks

Waits for the presence of a string at a screen location relative to the current terminal screen cursor.

Exceptions

Type	Condition
HostIntegratorConnectorException	Thrown if client is not connected
HostIntegratorConnectorException	Thrown an argument is invalid
HostIntegratorServerException	Thrown if the event times out
HostIntegratorConnectorException	Thrown an argument is invalid