Click a link below for any AppConn C method.
AddStringMapToSet AddStringToList AddStringToMap ClearStringList ClearStringMap ClearStringMapSet ConnectToModel ConnectToModelViaDomain ConnectToSession ConnectToSessionViaDomain CreateRecord CreateRecordSet CreateSession CreateStringList CreateStringMap CreateStringMapSet Disconnect EnableTerminalAttributes ExecuteSQLStatement ExecuteSQLStatementWithMaxrows FetchRecords FieldAttributesEnabled GetAltDestinations GetAttributeAtCursor GetAttributeLocations GetAttributeLength GetAttributeMetaData GetAttributeReadVariable GetAttributes GetAttributesUsed GetAttributeWriteVariable GetColor GetColumnMax GetColumnMetaData GetColumnMin GetColumnType GetConnectionTimeout GetCurrentEntity GetCurrentRecord GetCurrentRecordIndex GetCurrentRecordSetName GetDefaultValue GetDestination GetElementByIndex GetElementByName GetElementMetaDataByIndex GetElementMetaDataByName GetElementName GetElements GetElemLocAt GetElemLocElementName GetElemLocElementType GetElemLocLeftColumn GetElemLocLength GetElemLocNumColumns GetElemLocNumRows GetElemLocOffset GetElemLocRegionType GetElemLocTopRow GetEntityAttributes GetEntityDescription GetEntityOperations GetEntityRecordSets GetErrorCode GetErrorMessage GetErrorMessageInfo GetErrorMessageCode GetErrorMessageParameterCount GetErrorMessageParameter GetErrorScreen GetErrorScreenColumns GetErrorScreenCursorColumn GetErrorScreenCursorPosition GetErrorScreenCursorRow GetErrorScreenEntityName GetErrorScreenRows GetErrorScreenFullText GetErrorScreenText GetErrorScreenTextRow GetFieldLength GetFieldLocations GetFieldMetaData GetFieldNames GetFilterColumns GetHomeEntityName GetInitialization GetInputColumns GetKey GetLastRequestID GetLocale GetLocalizedMessage GetLoggingLevel GetMetaDataDescription GetMetaDataOnlyFlag GetMajorVersion GetMetaDataName GetMetaDataType GetMethodTimeout GetMinorVersion GetModelEntities GetModelName GetModelVariableNames GetModelVariables GetModelVersionString GetNumElements GetNumElemLocs GetNumMessages GetNumRecordElements GetNumRecords GetNumStringMaps GetNumStringPairs GetNumStrings ReplaceStringAt GetOperationMetaData GetOperationTimeout GetOutputColumns GetPatternLocations GetProcedureMetaData GetProcedureType GetRecord GetRecordIndex GetRecordSetLocations GetRecordSetMetaData GetScrollMovements GetScrollOperation GetServerName GetSessionID GetSessionType GetStringAt GetStringAtOffset GetStringAtRowColumn GetStringByIndex GetStringByKey GetStringMapAt GetTableColumns GetTableDescription GetTableNames GetTableProcedures GetTermAttrsByIndex GetTermAttrsByName GetTermFieldLeftColumn GetTermFieldLength GetTermFieldOffset GetTermFieldTermAttr GetTermFieldTopRow GetTerminalFieldAtCursor GetVariableMetaData GetVariablesUsed GetVariableType GetVersionString InsertRecord InsertRecords InsertStringAtCursor InsertStringAtOffset InsertStringAtRowColumn IsAttributeReadable IsAttributeWriteable IsBlinking IsColumnKey IsColumnSeparated IsConnected IsDefaultOperation IsEncrypted IsFieldKey IsFieldReadable IsFieldWriteable IsHalfBrite IsHidden IsIntense IsNondisplay IsNumeric IsPenDetect IsProtected IsReadable IsRequiredFilter IsRequiredInput IsReverse IsSecureConnection IsUnderscore IsWriteable MoveCurrentRecordIndex NextRecord PerformAidKey PerformEntityOperation PerformTableProcedure ProcessString RecordFromXML RecordSetFromXML RecordSetToXML RecordToXML ReleaseElemLoc ReleaseElemLocList ReleaseErrorMessageInfo ReleaseErrorScreen ReleaseMetaData ReleaseRecord ReleaseRecordSet ReleaseSession ReleaseStringList ReleaseStringMap ReleaseStringMapSet ReleaseTermField ReleaseTerminalAttributes RemoveStringAt RemoveStringByIndex RemoveStringByKey RemoveStringMapAt ReplaceStringAt ReplaceStringByIndex ReplaceStringByKey ReplaceStringMapAt RequireSecureConnection ResumeConnection SelectCurrentRecord SelectRecordByFilter SelectRecordByIndex SetAttributes SetAttributesDelayed SetConnectionTimeout SetCurrentEntity SetCurrentRecordIndex SetCurrentRecordSetByName SetLocale SetLoggingLevel SetMetaDataOnlyFlag SetMethodTimeout SetModelVariables SupportsDirectInserts SupportsSelect SuspendConnection TerminalAttributesEnabled UpdateCurrentRecord UpdateRecordByFilter UpdateRecordByIndex UpdateRecords UsedForSQL WaitForCondition WaitForCursor WaitForEntityChange WaitForString WaitForStringRelCursor
Create an AppConn session.
SessionHandle CreateSession();
A handle to a Host Integrator session.
Method used to establish a connection to a Host Integrator Server and create or allocate a host session with the specified model. The model must be specified.
int ConnectToModel (SessionHandle hSession, const CharType *strServer, const CharType *strModelName, const CharType *strUserID, const CharType *strPassword, StringMapHandle hModelVariables);
[in] The Host Integrator session.strServer
strModelName[in] The name of the Host Integrator Server to connect to.
strUserID[in] The name of the Host Integrator model to use.
strPassword[in] The user ID that Host Integrator uses to authenticate the user.
hModelVariables[in] The password that Host Integrator uses to authenticate the user.
[in] An optional list of variable names paired with values (handle to a StringMap Object).
A 1 is returned if the function succeeds, and a 0 is returned if the function does not succeed.
Reasons for failure include:
See the Error Handling topic for details.
Method used to establish a connection to a Host Integrator Server and create or allocate a host session with the specified model in the specified Host Integrator Domain via an AADS server. The model must be specified.
int ConnectToModelViaDomain (SessionHandle hSession, const CharType *strDirectoryServer, const CharType *strDomainName, const CharType *strModelName, const CharType *strUserID, const CharType *strPassword, StringMapHandle hModelVariables);
[in] The Host Integrator session.strDirectoryServer
[in] The name of the Directory Server.strDomainName
[in] The name of the Host Integrator Domain to use.strModelName
[in] The name of the Host Integrator model to use.strUserID
[in] The user ID that Host Integrator uses to authenticate the user.strPassword
[in] The password that Host Integrator uses to authenticate the user.hModelVariables
[in] An optional list of variable names paired with values (handle to a StringMap Object).
A 1 is returned if the function succeeded, and 0 if the function did not succeed.
Reasons for failure include:
See the Error Handling topic for details.
The parameters user ID and password are used by Host Integrator Server if the security option is ON.
Method used to establish a connection to a Host Integrator Server and create or allocate a host session with the specified session. The session must be specified.
int ConnectToSession (SessionHandle hSession, const CharType *strServer, const CharType *strSession, const CharType *strUserID, const CharType *strPassword, StringMapHandle hModelVariables);
[in] The Host Integrator session.strServer
[in] The name of the Host Integrator Server to connect to.strSession
[in] The name of the Host Integrator session to use.strUserID
[in] The user ID that Host Integrator uses to authenticate the user.strPassword
[in] The password that Host Integrator uses to authenticate the user.hModelVariables
[in] An optional list of variable names paired with values (handle to a StringMap Object).
A 1 is returned if the function succeeds, and 0 is returned if the function does not succeed.
Reasons for failure include:
See the Error Handling topic for details.
The parameters user ID and password are used by the Host Integrator Server if the security option is ON.
Method used to establish a connection to a Host Integrator Server and create or allocate a host session with the specified session in the specified Host Integrator Domain via an AADS server. The session must be specified.
int ConnectToSessionViaDomain (SessionHandle hSession, const CharType *strDirectoryServer, const CharType *strDomainName, const CharType *strSession, const CharType *strUserID, const CharType *strPassword, StringMapHandle hModelVariables);
[in] The Host Integrator session.strDirectoryServer
[in] The name of the directory server.strDomainName
[in] The name of the Host Integrator Domain to use.strSession
[in] The name of the Host Integrator session to use.strUserID
[in] The user ID that Host Integrator uses to authenticate the user.strPassword
[in] The password that Host Integrator uses to authenticate the user.hModelVariables
[in] An optional list of variable names paired with values (handle to a StringMap Object).
A flag indicating whether the function succeeded or not.
Reasons for failure include:
See the Error Handling topic for details.
The parameters user ID and password are used by Host Integrator Server if the security option is ON.
Method used to disconnect from a Host Integrator session.
int Disconnect (SessionHandle hSession, int nReserved);
[in] The Host Integrator session.nReserved
[in] Reserved parameter: use 0.
Reasons for failure include:
See the Error Handling topic for details.
Method used to enable terminal attributes to be returned from the server with model recordsets.
int EnableTerminalAttributes (SessionHandle hSession, int bEnable);
[in] The Host Integrator session.bEnable
[in] A flag.
An integer value indicating whether or not the call succeeded (succeeded = !0, failed = 0).
Reasons for failure include:
See the Error Handling topic for details.
Method used to execute an SQL statement on a table defined in the model.
RecordSetHandle ExecuteSQLStatement(SessionHandle hSession, const CharType *strSQLStatement);
[in] The Host Integrator session.strSQLStatement
[in] The SQL statement to execute.
Reasons for failure include:
See the Error Handling topic for details.
Method used to execute an SQL statement on a table defined in the model and
specifying maximum number of rows.
RecordSetHandle ExecuteSQLStatementWithMaxrows(SessionHandle hSession, const CharType *strSQLStatement, long maxRows);
[in] The Host Integrator session.strSQLStatement
[in] The SQL statement to execute.maxRows
[in] Maximum number of rows to be fetched, or zero if all rows are to be returned.
Method used to fetch up to max rows of data from the Host Integrator Server for the current recordSet of the current entity. If the number of rows to fetch is specified as 0 then the number of rows returned is not limited. If this is the first fetch following an explicit position of the current record, fetchRecords includes the current record in the returned set of records. Otherwise, the set of records returned begins with the first record following the current record. After a fetchRecords, the current record is the last record included in returned set of records. If fieldNames is null, fetchRecords returns all fields for each record.
RecordSetHandle FetchRecords(SessionHandle hSession, long nMaxRows, StringListHandle hFieldNames, const CharType *strFilterExpression);
[in] The Host Integrator session.nMaxRecords
[in] The maximum number of rows to return with the fetch.hFieldNames
[in] List of the field names to fetch from the entitystrFilterExpression
[in] An expression that qualifies the records to fetch. See Using Filter Expressions.
Reasons for failure include:
See the Error Handling topic for details.
Method used to get the name of the attribute at the current cursor position. This method returns the length of the attribute name string that was copied into the *strAttributeName parameter. If the cursor is not at a defined attribute, the return value is 0 and the *strAttributeName parameter is set to "".
long GetAttributeAtCursor(SessionHandle hSession, CharType *strAttributeName, long nBufferLen);
[in] The Host Integrator session.strAttributeName
[out] Buffer to retrieve the attribute name.nBufferLen
[in] The length of the buffer.
Method used to get a metadata object for an attribute for an entity in the Host Integrator model.
AttributeMetaDataHandle GetAttributeMetaData(SessionHandle hSession, const CharType *strEntityName, const CharType *strAttributeName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.strAttributeName
[in] Name of the attribute of the entity in the Host Integrator model.
Method used to get the attributes of the current entity. If attributeNames is null, getAttributes returns all attributes of the entity.
RecordHandle GetAttributes(SessionHandle hSession, StringListHandle hAttributeNames);
[in] The Host Integrator session.hAttributeNames
[in] List of attribute names to get from the entity.
A record handle which contains the attributes on the current entity. If the
attributes names parameter is non-null, then only named attributes are retrieved. If the statement fails the return value is null. The handle
must be destroyed with the ReleaseRecord method after it is no longer in use.
Method used to get a metadata object for a column of a table in the Host Integrator model. The handle must be destroyed with the ReleaseMetaData method after it is no longer in use.
ColumnMetaDataHandle GetColumnMetaData(SessionHandle hSession, const CharType *strTableName, const CharType *strColumnName);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.strColumnName
[in] Name of the column of the table in the Host Integrator model.
Gets 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).
The default value is 30 seconds.
long GetConnectionTimeout(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the current entity (i.e. screen) of the legacy application.
long GetCurrentEntity(SessionHandle hSession, CharType *strEntityName, long nBufferLen);
[in] The Host Integrator session.strEntityName
[out] Buffer to retrieve the entity name.nBufferLen
[in] The length of the buffer.
Method used to get the current record in the current recordSet.
RecordHandle GetCurrentRecord(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the index number of the current record in the current recordSet.
long GetCurrentRecordIndex(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the name of the current recordSet.
long GetCurrentRecordSetName(SessionHandle hSession, CharType *strRecordSetName, long nBufferLen);
[in] The Host Integrator session.strRecordSetName
[out] Buffer to retrieve the recordset name.nBufferLen
[in] The length of the buffer.
Method used to get the attribute names of an entity in the Host Integrator model.
StringListHandle GetEntityAttributes(SessionHandle hSession, const CharType *strEntityName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.
Method used to get the description for an entity in the Host Integrator model.
long GetEntityDescription(SessionHandle hSession, const CharType *strEntityName, CharType *strDescription, long nBufferLen);
[in] The Host Integrator session.strEntityName
strDescription[in] The display offset.
nBufferLen[out] Buffer to retrieve the entity description.
[in] The length of the buffer.
The length of the entity description retrieved. If there is an error -1 is
returned.
Method used to get the operation names of an entity in the Host Integrator model.
StringListHandle GetEntityOperations(SessionHandle hSession, const CharType *strEntityName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.
Method used to get the recordset names of an entity in the Host Integrator model.
StringListHandle GetEntityRecordSets(SessionHandle hSession, const CharType *strEntityName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.
A string list handle which contains the names of the entity recordsets. If the retrieval fails the return value is null. The handle must be destroyed with the ReleaseStringList method after it is no longer in use.
Returns a handle to access a terminal screen dump made when an error was reported.
If a non-zero handle is returned by this function, it must be released after
use.
ErrorScreenHandle GetErrorScreen(SessionHandle hSession);
hSession
[in] The Host Integrator session.
ErrorScreenHandle. This is a non-zero value if there is an error screen available.
Returns the number of columns in an error screen.
int GetErrorScreenColumns(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle for the error screen.
Number of columns, or zero if there is no error screen
Returns the zero-based column position of the cursor of an error screen.
int GetErrorScreenCursorColumn(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle for the error screen.
Zero-based column position, or -1 if there is no error screen.
Returns the zero-based cursor offset an error screen.
int GetErrorScreenCursorPosition(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle for the error screen.
Zero-based cursor offset, or -1 if there is no error screen.
Returns the zero-based row position an error screen.
int GetErrorScreenCursorRow(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle for the error screen.
Zero-based row position, or -1 if there is no error screen.
Returns the entity name, if there is one, for an error screen.
int GetErrorScreenEntityName(ErrorScreenHandle hErrorScreen,
CharType *strEntityName, long nBufferLen);
ErrorScreenHandle
Handle for the error screen.
StrEntityName
Buffer to receive the entity name.
nBufferLen
Maximum number of characters the buffer can accept, including the terminating NUL character.
Number of characters in the entity name, zero if there is no entity, or -1 if there is no error screen.
Returns the number of rows in an error screen.
int GetErrorScreenRows(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle for the error screen.
Number of rows in an error screen, or zero if there is no error screen.
Returns all of the screen text from an error screen.
int GetErrorScreenFullText(ErrorScreenHandle hErrorScreen,
CharType *strText, long nBufferLen);
ErrorScreenHandle
Handle for the error screen.
strText
Buffer to receive the text.
nBufferLen
Maximum number of characters the buffer can accept, including the terminating NUL character. A good number would be rows * columns +1.
Number of characters returned, or zero if there is no error screen.
Returns a selected portion of the screen text from an error screen.
int GetErrorScreenText(ErrorScreenHandle hErrorScreen,int offset, int length,
CharType *strText, long nBufferLen);
ErrorScreenHandle
Handle for the error screen.
offset
Zero-based offset within the error screen for the selected text.
length
Number of characters of text to be obtained.
strText
Buffer to receive the text.
nBufferLen
Maximum number of characters the buffer can accept, including the terminating NUL character. Ideally, this would be length + 1.
Number of characters returned, or zero if there is no error screen.
Returns a single row of text from an error screen.
int GetErrorScreenTextRow(ErrorScreenHandle hErrorScreen,int row,
CharType *strText, long nBufferLen);
ErrorScreenHandle
Handle for the error screen.
row
Zero-based row index for which the text is obtained.
strText
Buffer to receive the text.
nBufferLen
Maximum number of characters the buffer can accept, including the terminating NUL character. Ideally, this would be number of columns + 1.
Number of characters returned, or zero if there is no error screen.
Method used to get a metadata object for a field for an entity recordset in
the Host Integrator model.
FieldMetaDataHandle GetFieldMetaData(SessionHandle hSession, const CharType *strEntityName, const CharType *strRecordSetName, const CharType *strFieldName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.strRecordSetName
[in] Name of the recordset.strFieldName
[in] Name of the field.
Method used to get an integer identifier for the most recent transaction performed
against the current Host Integrator Server Session.
long GetLastRequestID(SessionHandle hSession);
[in] The Host Integrator session.
A unique id for the last request performed against the server. If a request has not yet been performed in the current session, this method returns 0. If not connected, this method returns -1.
Method used to get the method timeout for an Host Integrator Server Session.
long GetMethodTimeout(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the entity names of the legacy application.
StringListHandle GetModelEntities(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the name of the Host Integrator model for the current session.
long GetModelName(SessionHandle hSession, CharType *strModelName, long nBufferLen);
[in] The Host Integrator session.strModelName
[out] Buffer to retrieve the model name.nBufferLen
[in] The string length.
Method used to get the names and values of a variables in the Host Integrator model.
StringMapHandle GetModelVariables(SessionHandle hSession);
[in] The Host Integrator session.nOffset
Method used to get an metadata object for an operation of an entity.
OperationMetaDataHandle GetOperationMetaData(SessionHandle hSession, const CharType *strEntityName, const CharType *strOperationName);
[in] The Host Integrator session.strEntityName
[in] Name of an entity in the Host Integrator model.strOperationName
[in] Name of the operation.
Method used to get a metadata object for a procedure of a table.
ProcedureMetaDataHandle GetProcedureMetaData(SessionHandle hSession, const CharType *strTableName, const CharType *strProcedureName);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.strProcedureName
[in] Name of the procedure.
Method used to get an metadata object for a recordset of an entity.
RecordSetMetaDataHandle GetRecordSetMetaData(SessionHandle hSession, const CharType *strEntityName, const CharType *strRecordSetName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.strRecordSetName
[in] Name of the recordset.
Method used to get the name of the Host Integrator Server for the current session.
long GetServerName(SessionHandle hSession, CharType *strServerName, long nBufferLen);
[in] The Host Integrator session.strServerName
[out] Buffer to retrieve the server name.nBufferLen
[in] The length of the buffer.
Method used to get an integer identifier for the current Host Integrator Server Session.
long GetSessionID(SessionHandle hSession);
[in] The Host Integrator session.
Gets the terminal emulation type of the host session.
The returned value can be:
long GetSessionType(SessionHandle hSessionType);
[in] The Host Integrator session.
Get the string at the given offset of the given length.
long GetStringAtOffset(SessionHandle hSession, long nOffset, long nLength, CharType *strString, long nBufferLen);
[in] The Host Integrator session.nOffset
[in] The offset on the entity (i.e. terminal screen)..nLength
[in] The string length.strString
[out] Buffer to retrieve the string.nBufferLen
[in] The length of the buffer.
Method used to get a string of the given length from the current entity on
the host session starting at a given row and column.
long GetStringAtRowColumn(SessionHandle hSession, long nTopRow, long nLeftColumn, long nNumRows, long nNumColumns, CharType *strString, long nBufferLen);
[in] The Host Integrator session.nTopRow
[in] The starting row on the entity (i.e. terminal screen).nLeftColumn
[in] The starting column on the entity (i.e. terminal screen).nNumRows
[in] The number of rows to get relative to the starting row.nNumColumns
[in] The number of columns to get relative to the starting column.strString
[out] Buffer to retrieve the string.nBufferLen
[in] The length of the buffer.
Method used to get the column names of a table.
StringListHandle GetTableColumns(SessionHandle hSession, const CharType *strTableName);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.
Method used to get the description for a table in the Host Integrator model.
long GetTableDescription(SessionHandle hSession, const CharType *strTableName, CharType *strDescription, long nBufferLen);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.strDescription
[out] Buffer to retrieve the description.nBufferLen
[in] The length of the buffer.
Method used to get the table names in the Host Integrator model.
StringListHandle GetTableNames(SessionHandle hSession);
[in] The Host Integrator session.
Method used to get the procedures names for a table.
StringListHandle GetTableProcedures(SessionHandle hSession, const CharType *strTableName);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.
Method used to get a metadata object for a model variable in the Host Integrator
model.
VariableMetaDataHandle GetVariableMetaData(SessionHandle hSession, const CharType *strVariableName);
[in] The Host Integrator session.strVariableName
[in] Name of the variable in the Host Integrator model.
Method used to perform the insert operation for the current recordset.
int InsertRecord(SessionHandle hSession, StringMapHandle hRecord);
[in] The Host Integrator session.hRecord
[in] A map containing name-value pairs for the record elements to insert.
Method used to insert a string into the current entity on a host session starting at an offset.
int InsertStringAtOffset(SessionHandle hSession, const CharType *strString, long nOffset);
[in] The Host Integrator session.strString
[in] The string.nOffset
[in] The offset on the entity (i.e. terminal screen).
Method used to insert a string into the current entity on the host session starting at the given row and column.
int InsertStringAtRowColumn(SessionHandle hSession, const CharType *strString, long nRowNum, long nColumnNum);
[in] The Host Integrator session.strString
[in] The string.nRowNum
[in] The row number of the string on the entity (i.e. terminal screen).nColumnNum
[in] The column number of the string on the entity (i.e. terminal screen).
Method used to determine if the Host Integrator Server Session is connected.
int IsConnected(SessionHandle hSession);
[in] The Host Integrator session.
Method used to determine if the Host Integrator Server Session is using a secure connection.
int IsSecureConnection(SessionHandle hSession);
[in] The Host Integrator session.
Method used to move the current record index to a new position in the current recordSet.The movementCode can be one of the following enumerated values defined in appconndef.h:
int MoveCurrentRecordIndex(SessionHandle hSession, unsigned long nMovement);
[in] The Host Integrator session.nMovement
[in] The enumerated value for the type of movement to perform.
Method used to get the next record in the current recordSet
RecordHandle NextRecord(SessionHandle hSession, const CharType *strFilterExpression);
[in] The Host Integrator session.strFilterExpression
[in] An expression that qualifies the conditions for the next record. See Using Filter Expressions.
Method used to enter an aid key (for example, a Program Function key) into the current host session. The key is one of the terminal key enumerated values defined in appconndef.h.
int PerformAidKey(SessionHandle hSession, unsigned long nKey);
[in] The Host Integrator session.nKey
[in] The enumerated value for the perform. aid key.
An integer value indicating whether or not the call succeeded (succeeded = !0, failed = 0).
Method used to perform an operation on the current entity.
int PerformEntityOperation(SessionHandle hSession, const CharType *strOperationName);
[in] The Host Integrator session.strOperationName
[in] The operation name.
Method used to perform a procedure on a table defined in the model. hDataInputValues are required only for update and insert procedures, while hFilterValues are required for all procedures except update. If hOutputColumnNames is non-null, then the names in this supplied list determine which table columns are returned in the resulting AppConnRecordSet.If nMaxRows is zero then the number of rows returned is unlimited.
RecordSetHandle PerformTableProcedure(SessionHandle hSession, const CharType *strTableName, const CharType *strProcedureName, StringMapHandle hDataInputValues, StringMapHandle hFilterValues, int bFilterIsCaseSensitive, StringListHandle hOutputColumnNames, long nMaxRows);
[in] The Host Integrator session.strTableName
[in] Name of the table in the Host Integrator model.strProcedureName
[in] Name of the table procedure to perform.hDataInputValues
[in] Set of data input column name-value pairs to use.hFilterValues
[in] Set of filter column name-value pairs to use.bFilterIsCaseSensitive
[in] Integer value used to determine if comparison is case sensitive(true = !0, false = 0)..hOutputColumnNames
[in] List of the column names of the entity to return as output.nMaxRows
[in] The maximum number of rows to be returned.
Method used to require a secure channel on the next connection to a Host Integrator Server. This method has no effect on the current Host Integrator session if one is already established. If the setting is false, then the data object does not require a secure connection. In this case, the server security setting takes precedence. If the setting is true, the data object forces a secure connection even though the server setting is not set to require a secure channel.
Note: this call affects only subsequent connections to a Host Integrator Server.
int RequireSecureConnection(SessionHandle hSession, int bRequire);
[in] The Host Integrator session.bRequire
[in] Integer value used require secure connection(true = !0, false = 0).
Method used to resume the execution of a currently suspended Host Integrator server session. If the requested session is already running, this method does nothing.
int ResumeConnection(SessionHandle hSession, const CharType *strConnectionToken);
[in] The Host Integrator session.strConnectionToken
[in] The token received from the SuspendConnection method.
Method used to perform the selection operation for the current recordset.
int SelectCurrentRecord(SessionHandle hSession);
[in] The Host Integrator session.
Method used to find a record in the current recordset and perform its selection operation.
int SelectRecordByFilter(SessionHandle hSession, const CharType *strFilterExpression);
[in] The Host Integrator session.strFilterExpression
[in] An expression that qualifies the record to select. See Using Filter Expressions.
Method used to find a record in the current recordset and perform its selection operation.
int SelectRecordByIndex(SessionHandle hSession, long nIndex);
[in] The Host Integrator session.nIndex
[in] The index of the record to select.
Method used to set the attributes in the current entity. The map contains attributes (name/value pairs) that are to be inserted in the entity. The map does not need to contain all of the attributes for the entity, but should contain all of the required attributes for the entity.
int SetAttributes(SessionHandle hSession, StringMapHandle hAttributes);
[in] The Host Integrator session.hAttributes
[in] A map containing attributes (name/value pairs).
Method used to set the attributes of an entity. The map contains attributes (name/value pairs) that are to be set in the entity. The map does not need to contain all of the attributes for the entity, but should contain all of the required attributes for the entity. If the entity is not specified then the current entity is used.
int SetAttributesDelayed(SessionHandle hSession, StringMapHandle hAttributes, const CharType *strEntityName);
[in] The Host Integrator session.hAttributes
[in] A map containing attributes (name/value pairs).strEntityName
[in] Name of the entity in the Host Integrator model.
Method used to specify 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).
This method 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, include the number of connection attempts and the time of those attempts, is written to the log.
The default value is 30 seconds.
int SetConnectionTimeout(SessionHandle hSession, long nTimeout);
[in] The Host Integrator session.nTimeout
[in] The timeout period in seconds.
Method used to set the current entity. The legacy application traverses to the screen that corresponds to that entity.
int SetCurrentEntity(SessionHandle hSession, const CharType *strEntityName);
[in] The Host Integrator session.strEntityName
[in] Name of the entity in the Host Integrator model.
Method used to change the index number of the current record in the current recordset.
int SetCurrentRecordIndex(SessionHandle hSession, long nIndex);
[in] The Host Integrator session.nIndex
[in] The index of the record to make current.
Method used to set the current recordset by name. This is only needed if there is more than one recordSet for the current entity.
int SetCurrentRecordSetByName(SessionHandle hSession, const CharType *strRecordSetName);
[in] The Host Integrator session.strRecordSetName
[in] The name of the recordset to use for recordset methods.
Defines the current session as a "metadata-only" session. A metadata-only session does not require a host connection and allows only methods and properties that interact with metadata. You must set SetMetaDataOnlyFlag 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 SetMetaDataOnlyFlag property generates an error with this text: "The MetaDataOnly property cannot be changed while a connection is active."
When a client connects with SetMetaDataOnlyFlag set to true, the server does not report the connection as a session, and does not allocate a new session or a session from a pool. There is no indication in the Administrative WebStation or Session Monitor that there is an active client connection.
Use the GetMetaDataOnlyFlag property to determine the current value of the metadata-only flag.
int SetMetaDataOnlyFlag(SessionHandle hSession, int nMetaDataOnly);
[in] The Host Integrator session.nMetaDataOnly
[in] An integer value specifying whether or not to set the metadata-only flag (yes = !0, no = 0).
void myTestRoutine(void)
{
SessionHandle hSession;
int mdoflag;
hSession = CreateSession();
SetMetaDataOnlyFlag(hSession, 1); // Make this a metadata-only connection
mdoflag = GetMetaDataOnlyFlag( hSession );
printf("Metadata-only flag = %d\n", mdoflag);
ConnectToModel( hSession, srvr, model, userid, password, 0);
...
Disconnect(hSession, 0);
ReleaseSession( hSession );
}
Method used to set the method timeout for a Host Integrator Server Session.
int SetMethodTimeout(SessionHandle hSession, long nTimeout);
[in] The Host Integrator session.nTimeout
[in] The timeout period in milliseconds.
Method used to set the values of variables in the Host Integrator model.
int SetModelVariables(SessionHandle hSession, StringMapHandle hVariables);
[in] The Host Integrator session.hVariables
[in] A collection of name/value pairs for the variables.
Method used to suspend the execution of a currently running Host Integrator Server Persistent Session. On successful suspension, the methods returns a token to be used when resuming the session. If the current session is already suspended, this method does nothing. The suspended session automatically terminates if it is not resumed before the specified timeout period elapses.
long SuspendConnection(SessionHandle hSession, long nTimeout, CharType *strConnectionToken, long nBufferLen);
[in] The Host Integrator session.nTimeout
[in] The timeout value to use for the suspended session in minutes.strConnectionToken
[out] Buffer to retrieve the description.nBufferLen
[in] The length of the buffer.
Method used to change the values of the current record in the current record
set.
int UpdateCurrentRecord(SessionHandle hSession, StringMapHandle hRecord);
[in] The Host Integrator session.hRecord
[in] A map containing name-value pairs for the record elements to insert.
Method used to change the values of a record in the current recordset. The
record to change is the first one after the current record that satisfies the
filter expression.
int UpdateRecordByFilter(SessionHandle hSession, StringMapHandle hRecord, const CharType *strFilterExpression);
[in] The Host Integrator session.hRecord
[in] A map containing name-value pairs for the record elements to insert.strFilterExpression
[in] An expression that qualifies the record to update. See Using Filter Expressions.
Method used to change the values of a record in the current recordSet. The
record to change is selected by the provided index number.
int UpdateRecordByIndex(SessionHandle hSession, StringMapHandle hRecord, long nIndex);
[in] The Host Integrator session.hRecord
[in] A map containing name-value pairs for the record elements to insert.nIndex
[in] The index of the record to update.
Method used to change the values of a record in the current recordSet. The
record to change is the first one after the current record that satisfies the
filter expression.
long UpdateRecords(SessionHandle hSession, StringMapHandle hRecord, const CharType *strFilterExpression);
[in] The Host Integrator session.hRecord
[in] A map containing name-value pairs for the record elements to insert.strFilterExpression
[in] An expression that qualifies the record to update. See Using Filter Expressions.
Method used to wait for the presence of the terminal cursor at a particular
terminal screen offset. Exception occurs if timeout period elapses before the
cursor is at the offset.
int WaitForCursor(SessionHandle hSession, long nRowNum, long nColumnNum, long nTimeout);
[in] The Host Integrator session.nRowNum
[in] The row on the entity (i.e. terminal screen) for the cursor.nColumnNum
[in] The column on the entity (i.e. terminal screen) for the cursor.nTimeout
[in] The timeout period in milliseconds.
Method used to wait for the recognition of a new entity that is not 'strEntityName'.
If entityName is null or empty, the method returns upon recognition of any new
entity. Exception occurs if timeout period elapses before the Verastream Server
recognizes a new entity.
int WaitForEntityChange(SessionHandle hSession, const CharType *strEntityName, long nTimeout);
[in] The Host Integrator session.strEntityName
[in] The name of the entity that cannot satisfy the entity change condition, typically the entity that was current when the method is called.nTimeout
[in] The timeout period in milliseconds.
Method used to wait for the presence of a string starting at a particular terminal
screen row and column. Exception occurs if timeout period elapses before the
string appears at the row and column.
int WaitForString(SessionHandle hSession, const CharType *strString, long nRowNum, long nColumnNum, long nTimeout);
[in] The Host Integrator session.strString
[in] The string.nRowNum
[in] The row on the entity (i.e. terminal screen) of the beginning of the string.nColumnNum
[in] The column on the entity (i.e. terminal screen) of the beginning of the string.nTimeout
[in] The timeout period in milliseconds.
Method used to wait for the presence of a string relative to the current terminal
screen cursor. Exception occurs if timeout period elapses before the string
appears at the offset.
int WaitForStringRelCursor(SessionHandle hSession, const CharType *strString, long nRowOffset, long nColumnOffset, long nTimeout);
[in] The Host Integrator session.strString
[in] The string.nRowOffset
[in] The row offset from the cursor (i.e. terminal screen) of the beginning of the string.nColumnNum
[in] The column offset from the cursor (i.e. terminal screen) of the beginning of the string.nTimeout
[in] The timeout period in milliseconds.
Method used to release an AppConn session.
int ReleaseSession(SessionHandle hSession);
[in] The Host Integrator session.
Create an AppConn recordset.
RecordSetHandle CreateRecordSet(void);
A handle to a recordset.
Method used to get the number of records in the recordset.
long GetNumRecords(RecordSetHandle hRecordSet);
[in] An AppConn recordset.
Method used to get the number of fields in the records of the recordset.
long GetNumRecordElements(RecordSetHandle hRecordSet);
[in] An AppConn recordset.
Method used to get a record of the recordset.
RecordHandle GetRecord(RecordSetHandle hRecordSet, long nRecordNo);
[in] An AppConn recordset.nRecordNo
[in] Index of the record to get.
A record handle which contains the fields of the retrieved record. If the retrieval fails the return value is null. The handle must be destroyed with the ReleaseRecord method after it is no longer in use.
Indexing of records through the Verastream API is 0-based, so to get the first record in your recordset you do a GetRecord(myRecordSet, 0). (Contrast with GetRecordIndex, which uses 1-based indexing.)
Method used to get the metadata for an element in the records of the recordset.
ElementMetaDataHandle GetElementMetaDataByName(RecordSetHandle hRecordSet, const CharType *strElementName);
[in] An AppConn recordset.strElementName
[in] Name of the element to get the metadata.
Method used to get the metadata for an element in the records of the record set.
ElementMetaDataHandle GetElementMetaDataByIndex(RecordSetHandle hRecordSet, long nElementNo);
[in] An AppConn recordset.nElementNo
[in] Index of the element to get the metadata.
Method used to convert from an AppConn recordset to an XML String.
long RecordSetToXML(RecordSetHandle hRecordSet, const CharType *strDTDURL, CharType *strXMLString, long nBufferLen);
[in] An AppConn recordset.strDTDURL
[in] The URL of the DTD to be used for the XML result.strXMLString
[out] Buffer to retrieve the XML string. If strXMLString is passed in as NULL, RecordSetToXML returns the length of buffer necessary to accommodate the XML string.nBufferLen
[in] The length of the buffer.
Method used to convert from an XML String to an AppConn recordset.
int RecordSetFromXML(RecordSetHandle hRecordSet, const CharType *strXMLString);
[in] An AppConn recordset.strXMLString
[in] Buffer to retrieve the XML string.
Method used to release an AppConn recordset. All elements of the recordset
are released.
int ReleaseRecordSet(RecordSetHandle hRecordSet);
[in] AppConn recordset.
Create an AppConn record.
RecordHandle CreateRecord(void);
A handle to a record.
Method used to get Host Integrator recordset index of the record.
long GetRecordIndex(RecordHandle hRecord);
[in] AppConn record.
The Host Integrator recordset index. If record did not come from a recordset the index is -1.
Indexing of records is based on model-runtime indexing, which starts with 1. (Contrast with GetRecord, which uses 0-based indexing). So the index of the first record in a recordset is 1.
Method used to get version information for the current model. The string returned uniquely identifies the version of the model deployed to the Host Integrator Server.
GetModelVersionString(SessionHandle hSession, CharType * strModelVersionString, long nBufferLen);
hSession
[in] The Host Integrator session.
strModelVersionString
[in] Buffer to retrieve the model version string
nBufferLen
[in] The length of the buffer.
The length of the version string retrieved.
Method used to get the number of elements in the record.
long GetNumElements(RecordHandle hRecord);
[in] AppConn record.
Method used to get the name of an element in the record.
long GetElementName(RecordHandle hRecord, long nElementNo, CharType *strElementName, long nBufferLen);
[in] AppConn record.nElementNo
[in] Index of the element to get.strElementName
[out] Buffer to retrieve the element name.nBufferLen
[in] The length of the buffer.
Method used to get an element in the record.
long GetElementByIndex(RecordHandle hRecord, long nElementNo, CharType *strElementValue, long nBufferLen);
[in] AppConn record.nElementNo
[in] Index of the element to get.strElementName
[out] Buffer to retrieve the element name.nBufferLen
[in] The length of the buffer.
Method used to get an element in the record.
long GetElementByName(RecordHandle hRecord, const CharType *strElementName, CharType *strElementValue, long nBufferLen);
[in] AppConn record.strElementName
[in] Name of the element to get.strElementValue
[out] Buffer to retrieve the element value.nBufferLen
[in] The length of the buffer.
Method used to get the elements (key/value pairs) in the record.
StringMapHandle GetElements(RecordHandle hRecord);
[in] AppConn record.
Method used to get the terminal attributes of an element in the record.
TerminalAttributesHandle GetTermAttrsByIndex(RecordHandle hRecord, long nElementNo);
[in] AppConn record.nElementNo
[in] Index of the element to get.
A terminal attributes handle for the element. If the retrieval fails the return value is null. The handle must be destroyed with the ReleaseTerminalAttributes method after it is no longer in use.
Method used to get the terminal attributes of an element in the record.
TerminalAttributesHandle GetTermAttrsByName(RecordHandle hRecord, const CharType *strElementName);
[in] AppConn record.strElementName
[in] Name of the element to get.
Calls the ProcessString event handler on the server.
long ProcessString(SessionHandle hSession, const CharType *strIn, const CharType *strOut, long nBufferLen);hSession
[in] The Host Integrator session.strIn
[in] The string to be passed to the ProcessString event handler.strOut
[in] Buffer to retrieve the results returned by the ProcessString event handler.
nBufferLen
[in] The length of the buffer.
The length of the results returned from the ProcessString event handler.
Method used to convert from an AppConn record to an XML String.
long RecordToXML(RecordHandle hRecord, const CharType *strDTDURL, CharType *strXMLString, long nBufferLen);
[in] AppConn record.strDTDURL
[in] The URL of the DTD to be used for the XML result.strXMLString
[out] Buffer to retrieve the XML string.nBufferLen
[in] The length of the buffer.
Method used to convert from an XML String to an AppConn record.
int RecordFromXML(RecordHandle hRecord, const CharType *strXMLString);
[in] AppConn record.strXMLString
[in] Buffer to retrieve the XML string.
Method used to release an AppConn record. All elements of * the record are released.
int ReleaseRecordSet(RecordSetHandle hRecordSet);
[in] AppConn record.
Create an AppConn string list.
StringListHandle CreateStringList(void);
A handle to a string list.
Method used to add a string to the string list.
int AddStringToList(StringListHandle hStringList, const CharType *strString);
[in] AppConn string list.strString
[in] String to add to the list.
Method used to remove all the strings from the string list.
int ClearStringList(StringListHandle hStringList);
[in] AppConn string list.
Method used to get the number of strings in the string list.
long GetNumStrings(StringListHandle hStringList);
[in] AppConn string list.
Method used to get a string in the string list.
long GetStringAt(StringListHandle hStringList, long nIndex, CharType *strString, long nBufferLen);
[in] AppConn string list.nIndex
[in] Index of the string to get.strString
[out] Buffer to retrieve the string.nBufferLen
[in] The length of the buffer.
Method used to replace a string in the string list.
int ReplaceStringAt(StringMapHandle hStringMap, long nIndex, const CharType *strString);
[in] AppConn string list.nIndex
[in] Index of the string to get.strString
[in] String to replace the existing entry.
Method used to remove a string from the string list.
int RemoveStringAt(StringListHandle hStringList, long nIndex);
[in] AppConn string list.nIndex
[in] Index of the string to remove.
An integer value indicating whether or not the call succeeded (succeeded = !0, failed = 0).
Release an error screen and free the resources associated with it.
int ReleaseErrorScreen(ErrorScreenHandle hErrorScreen);
ErrorScreenHandle
Handle of error screen to be released.
1 with success of error screen release, 0 on failure.
Method used to release an AppConn string list. All elements of the string list
are released.
int ReleaseStringList(StringListHandle hStringList);
[in] AppConn string list.
Create an AppConn string map.
StringMapHandle CreateStringMap(void);
A handle to a string map.
Method used to add a key/value pair to the string map.
int AddStringToMap(StringMapHandle hStringMap, const CharType *strKey, const CharType *strString);
[in] AppConn string map.strstrKeyString
[in] Key to add to the map.strString
[in] String to add to the map.
Method used to remove all the strings from the string map.
int ClearStringMap(StringMapHandle hStringMap);
[in] AppConn string map.
Method used to get the number of string/value pairs in the string map.
long GetNumStringPairs(StringMapHandle hStringMap);
[in] AppConn string map.
Method used to get a key in the string map.
long GetKey(StringMapHandle hStringMap, long nIndex, CharType *strKey, long nBufferLen);
[in] AppConn string map.nIndex
[in] Index of the key to get.strKey
[out] Buffer to retrieve the key.nBufferLen
[in] The length of the buffer.
Method used to get a string in the string map.
long GetStringByIndex(StringMapHandle hStringMap, long nIndex, CharType *strString, long nBufferLen);
[in] AppConn string map.nIndex
[in] Index of the key to get.strString
[out] Buffer to retrieve the string.nBufferLen
[in] The length of the buffer.
Method used to get a string in the string map.
long GetStringByKey(StringMapHandle hStringMap, const CharType *strKey, CharType *strString, long nBufferLen);
[in] AppConn string map.strKey
[in] Key of the string to get.strString
[out] Buffer to retrieve the string.nBufferLen
[in] The length of the buffer.
Method used to replace a string in the string map.
int ReplaceStringByIndex(StringMapHandle hStringMap, long nIndex, const CharType *strString);
[in] AppConn string map.nIndex
[in] Index of the string to get.strString
[in] String to replace the existing entry.
Method used to replace a string in the string map.
int ReplaceStringByKey(StringMapHandle hStringMap, const CharType *strKey, const CharType *strString);
[in] AppConn string map.strKey
[in] Key of the string to get.strString
[in] String to replace the existing entry.
Method used to remove a string from the string map.
int RemoveStringByIndex(StringMapHandle hStringMap, long nIndex);
[in] AppConn string map.nIndex
[in] Index of the string to remove.
Method used to remove a string from the string map.
int RemoveStringByKey(StringMapHandle hStringMap, const CharType *strKey);
[in] AppConn string map.strKey
[in] Key of the string to remove.
Method used to release an AppConn string map. All elements of the string map
are released.
int ReleaseStringMap(StringMapHandle hStringMap);
[in] AppConn string map.
Method used to get the metadata name.
long GetMetaDataName(MetaDataHandle hMetaData, CharType *strName, long nBufferLen);
[in] AppConn metadata.strName
[out] Buffer to retrieve the name.nBufferLen
[in] The length of the buffer.
Method used to get the metadata description.
long GetMetaDataDescription(MetaDataHandle hMetaData, CharType *strDescription, long nBufferLen);
[in] AppConn metadata.strDescription
[out] Buffer to retrieve the description.nBufferLen
[in] The length of the buffer.
Determines whether the current session is "metadata only." A metadata only session does not require a host connection and allows only methods and properties that interact with metadata.
Use SetMetaDataOnlyFlag to set the metadata-only flag.
int GetMetaDataOnlyFlag(SessionHandle hSession);
[in] The Host Integrator session.
void myTestRoutine(void)
{
SessionHandle hSession;
int mdoflag;
hSession = CreateSession();
SetMetaDataOnlyFlag(hSession, 1); // Make this a metadata-only connection
mdoflag = GetMetaDataOnlyFlag( hSession );
printf("Metadata-only flag = %d\n", mdoflag);
ConnectToModel( hSession, srvr, model, userid, password, 0);
...
Disconnect(hSession, 0);
ReleaseSession( hSession );
}
Method used to get the metadata type.
The returned value is one of:long GetMetaDataType(MetaDataHandle hMetaData);
[in] AppConn metadata.
Method used to release an AppConn metadata.
int ReleaseMetaData(MetaDataHandle hMetaData);
[in] AppConn string map.
Method used to determine if the attribute is readable.
int IsAttributeReadable(AttributeMetaDataHandle hAttributeMetaData);
[in] Attribute metadata.
Method used to determine if the attribute is writeable.
int IsAttributeWriteable(AttributeMetaDataHandle hAttributeMetaData);
[in] Attribute metadata.
Method used to get the length of the attribute.
long GetAttributeLength(AttributeMetaDataHandle hAttributeMetaData);
[in] Attribute metadata.
Method used to get the read variable of the attribute.
long GetAttributeReadVariable(AttributeMetaDataHandle hAttributeMetaData, CharType *strReadVariable, long nBufferLen);
[in] Attribute metadata.strReadVariable
[out] Buffer to retrieve the read variable.nBufferLen
[in] The length of the buffer.
Method used to get the write variable of the attribute.
long GetAttributeWriteVariable(AttributeMetaDataHandle hAttributeMetaData, CharType *strWriteVariable, long nBufferLen);
[in] Attribute metadata.strWriteVariable
[out] Buffer to retrieve the write variable.nBufferLen
[in] The length of the buffer.
Method used to determine if terminal attribute are enabled on the attribute.
int TerminalAttributesEnabled(AttributeMetaDataHandle hAttributeMetaData);
[in] Attribute metadata.
Method used to determine if the field is a key. A key value is unique for the associated field in the recordset--no other records will have the same value for that field.
int IsFieldKey(FieldMetaDataHandle hFieldMetaData);
[in] Field metadata.
Method used to determine if the field is readable--that is, whether the field can be read by a client.
int IsFieldReadable(FieldMetaDataHandle hFieldMetaData);
[in] Field metadata.
Method used to determine if the field is writeable--that is, whether Host Integrator allows this field to have data written to it.
int IsFieldWriteable(FieldMetaDataHandle hFieldMetaData);
[in] Field metadata.
Method used to get the length of the field.
long GetFieldLength(FieldMetaDataHandle hFieldMetaData);
[in] Field metadata.
Method used to determine if terminal attribute are enabled for the field. The terminal attributes enabled flag indicates whether Host Integrator can return the terminal attributes of the field. Terminal attributes specify various properties the text can have, including color, whether the text is blinking, and whether the text is displayed in reverse video.
int FieldAttributesEnabled(FieldMetaDataHandle hFieldMetaData);
[in] Field metadata.
Method used to get the type of the column.
The returned value can be:
long GetColumnType(ColumnMetaDataHandle hColumnMetaData);
[in] Column metadata.
Method used to determine if the column is a key.
int IsColumnKey(ColumnMetaDataHandle hColumnMetaData);
[in] Column metadata.
Method used to get the min for the column. For integer columns the min is the minimum value that can be entered for that column. For text columns the min is the minimum length of a string that can be entered in that column.
long GetColumnMin(ColumnMetaDataHandle hColumnMetaData);
[in] Column metadata.
Method used to get the max for the column. For integer columns the max is the maximum value that can be entered for that column. For text columns the max is the maximum length of a string that can be entered in that column.
long GetColumnMax(ColumnMetaDataHandle hColumnMetaData);
[in] Column metadata.
Method used to get a list of alternative destinations of the operation.
StringListHandle GetAltDestinations(OperationMetaDataHandle hOperationMetaData);
[in] Operation metadata.
Method used to get a list of the attributes used in the operation.
StringListHandle GetAttributesUsed(OperationMetaDataHandle hOperationMetaData);
[in] Operation metadata.
Method used to get the destination of the operation.
long GetDestination(OperationMetaDataHandle hOperationMetaData, CharType *strDestination, long nBufferLen);
[in] Operation metadata.strDestination
[out] Buffer to retrieve the destination.nBufferLen
[in] The length of the buffer.
Method used to determine if the operation is the default.
int IsDefaultOperation(OperationMetaDataHandle hOperationMetaData);
[in] Operation metadata.
Method used to get a list of the variables used in the operation.
StringListHandle GetVariablesUsed(OperationMetaDataHandle hOperationMetaData);
[in] Operation metadata.
Method used to get a list of the filter columns for the procedure.
StringListHandle GetFilterColumns(ProcedureMetaDataHandle hProcedureMetaData);
[in] Procedure metadata.
Method used to get a list of the input columns for the procedure.
StringListHandle GetInputColumns(ProcedureMetaDataHandle hProcedureMetaData);
[in] Procedure metadata.
Method used to get a list of the output columns for the procedure.
StringListHandle GetOutputColumns(ProcedureMetaDataHandle hProcedureMetaData);
[in] Procedure metadata.
Method used to get the type of the procedure.
The returned value is one of:long GetProcedureType(ProcedureMetaDataHandle hProcedureMetaData);
[in] Procedure metadata.
Method used to determine if the procedure is a used for SQL.
int UsedForSQL(ProcedureMetaDataHandle hProcedureMetaData);
[in] Procedure metadata.
Method used to determine if the given column is a required filter.
int IsRequiredFilter(ProcedureMetaDataHandle hProcedureMetaData, const CharType *strColumnName);
[in] Procedure metadata.strColumnName
[in] column name.
Method used to determine if the given column is a required input.
int IsRequiredInput(ProcedureMetaDataHandle hProcedureMetaData, const CharType *strColumnName);
[in] Procedure metadata.strColumnName
[in] column name.
Method used to determine if the recordset supports direct inserts.
int SupportsDirectInserts(RecordSetMetaDataHandle hRecordSetMetaData);
[in] Recordset metadata.
Method used to determine if the recordset supports select.
int SupportsSelect(RecordSetMetaDataHandle hRecordSetMetaData);
[in] Recordset metadata.
Method used to get a list of the field names for the recordset.
StringListHandle GetFieldNames(RecordSetMetaDataHandle hRecordSetMetaData);
[in] Recordset metadata.
Method used to get a list of the scroll movements implemented for the record set.
long GetScrollMovements(RecordSetMetaDataHandle hRecordSetMetaData, long *pnScrollMovements, long nBufferLen);
[in] Recordset metadata.
pnScrollMovements
[out] Buffer to retrieve the scroll movements.nBufferLen
[in] The length of the buffer.
Method used to get the operation for the given scroll movement.
Scroll Movement values:
long GetScrollOperation(RecordSetMetaDataHandle hRecordSetMetaData, long nScrollMovement, CharType *strScrollOperation, long nBufferLen);
[in] Recordset metadata.nScrollMovements
[in] Buffer to retrieve the destination.strScrollOperation
[out] Buffer to retrieve the scroll operation.nBufferLen
[in] The length of the buffer.
Method used to get the default value of the variable.
long GetDefaultValue(VariableMetaDataHandle hVariableMetaData, CharType *strDefaultValue, long nBufferLen);
[in] Variable metadata.strDefaultValue
[out] Buffer to retrieve the scroll value.nBufferLen
[in] The length of the buffer.
Method used to get the method of initialization for the variable.
The returned value is one of:long GetInitialization(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method used to determine if the variable is encrypted.
int IsEncrypted(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method used to determine if the variable is hidden.
int IsHidden(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method used to determine if the variable is readable.
int IsReadable(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method used to determine if the variable is writeable.
int IsWriteable(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method used to get the type of the variable.
The returned value is one of:
long GetVariableType(VariableMetaDataHandle hVariableMetaData);
[in] Variable metadata.
Method to determine it the terminal attribute is blinking.
int IsBlinking(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is reverse.
int IsReverse(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is underscore.
int IsUnderscore(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is half brite.
int IsHalfBrite(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is protected.
int IsProtected(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is numeric.
int IsNumeric(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is nondisplay.
int IsNondisplay(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is column separated.
int IsColumnSeparated(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is pen detect.
int IsPenDetect(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method to determine it the terminal attribute is intense.
int IsIntense(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method used to get the terminal attribute's color value.
long GetColor(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method used to release a terminal attribute.
int ReleaseTerminalAttributes(TerminalAttributesHandle hTerminalAttributes);
[in] Terminal attribute.
Method used to the locations for a given set of attributes.
ElementLocationListHandle GetAttributeLocations(SessionHandle hSession, StringListHandle hAttributeNames);
[in] The Host Integrator session.
hAttributeNames
[in] Names of the attributes to get locations.
Method used to the locations for a given set of patterns.
ElementLocationListHandle GetPatternLocations(SessionHandle hSession, StringListHandle hPatternNames);
[in] The Host Integrator session.
hPatternNames
[in] Names of the patterns to get locations.
Method used to the locations for a given set of fields.
ElementLocationListHandle GetFieldLocations(SessionHandle hSession, StringListHandle hFieldNames);
[in] The Host Integrator session.
hPatternNames
[in] Names of the fields to get locations.
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:
Method used to the locations for a given set of recordsets.
ElementLocationListHandle GetRecordSetLocations(SessionHandle hSession, StringListHandle hRecordSetNames);
[in] The Host Integrator session.
hPatternNames
[in] Names of the recordsets to get locations.
Get the name of the home entity.
long GetHomeEntityName(SessionHandle hSession, CharType *strEntityName, long nBufferLen);
[in] The Host Integrator session.strEntityName
[out] Buffer to retrieve the entity name.nBufferLen
[in] The length of the buffer.
Method used to the terminal field at the cursor.
TerminalFieldHandle GetTerminalFieldAtCursor(SessionHandle hSession);
[in] The Host Integrator session.
Method used to perform the insert operation for the current recordset.
int InsertRecords(SessionHandle hSession, StringMapSetHandle hRecords);
[in] The Host Integrator session.hRecords
[in] A list of maps containing name-value pairs for the records to insert.
Method used to insert a string at the cursor on the current entity on a host session.
int InsertStringAtCursor(SessionHandle hSession, const CharType *strString);
[in] The Host Integrator session.strString
[in] The string.
Method used to get the logging level for an Host Integrator Server Session.
The returned value is one of:
[in] The Host Integrator session.
Method used to set the logging level for a Host Integrator Server Session.
The value to set is one of:int SetLoggingLevel(SessionHandle hSession, long nLoggingLevel);
[in] The Host Integrator session.nLoggingLevel
[in] The logging level.
Method used to wait on the given conditions. Exception occurs if timeout period
elapses before the conditions are met.
int WaitForCondition(SessionHandle hSession, long nTimeout, const CharType *strExpression, const CharType *strEntityName);
[in] The Host Integrator session.nTimeout
[in] The timeout period in milliseconds.strExpression
[in] The condition expression.strEntityName
[in] The entity name.
Method used to get the name of the element location.
long GetElemLocElementName(ElementLocationHandle hElementLocation, CharType *strElementName, long nBufferLen);
[in] Element location.strElementName
[out] Buffer to name.nBufferLen
[in] The length of the buffer.
Method used to get the type of the element.
The returned value is one of:long GetElemLocElementType(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the top row of the location.
long GetElemLocTopRow(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the left column of the location.
long GetElemLocLeftColumn(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the number of rows of the location.
long GetElemLocNumRows(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the number of columns of the location.
long GetElemLocNumColumns(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the offset of the location.
long GetElemLocOffset(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the length of the location.
long GetElemLocLength(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the type of the region.
The returned value is one of:long GetElemLocRegionType(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to release an Element Location.
int ReleaseElemLoc(ElementLocationHandle hElementLocation);
[in] Element location.
Method used to get the number of element locations in the list.
long GetNumElemLocs(ElementLocationListHandle hElementLocationList);
[in] An element location list handle.
Method used to get an element location in the list by index.
ElementLocationHandle GetElemLocAt(ElementLocationListHandle hElementLocationList, long nIndex);
[in] An element location list handle.nIndex
[in] Index for an element location.
Method used to release an Element Location List.
int ReleaseElemLocList(ElementLocationListHandle hElementLocationList);
[in] Element location list.
Method used to get the top row of the terminal field.
long GetTermFieldTopRow(TerminalFieldHandle hTerminalField);
[in] Terminal field.
Method used to get the left column of the terminal field.
long GetTermFieldLeftColumn(TerminalFieldHandle hTerminalField);
[in] Terminal field.
Method used to get the offset of the terminal field.
long GetTermFieldOffset(TerminalFieldHandle hTerminalField);
[in] Terminal field.
Method used to the terminal attributes of the terminal field.
TerminalAttributesHandle GetTermFieldTermAttr(TerminalFieldHandle hTerminalField);
[in] Terminal field.
Method used to release a Terminal Field
int ReleaseTermField(TerminalFieldHandle hTerminalField);
[in] Terminal field.
Create an AppConn string map list.
StringMapSetHandle CreateStringMapSet(void);
A handle to a string map list.
Method used to add a string map to the string map list.
int AddStringMapToSet(StringMapSetHandle hStringMapSet, const StringMapHandle hStringMap);
[in] AppConn string map list.hStringMap
[in] String map to add to the list.
Method used to remove all the strings maps from the string map list.
int ClearStringMapSet(StringMapSetHandle hStringMapSet);
[in] AppConn string map list.
Method used to get the number of string maps in the string map list.
long GetNumStringMaps(StringMapSetHandle hStringMapSet);
[in] AppConn string map list.
Method used to get a string in the string list.
StringMapHandle GetStringMapAt(StringMapSetHandle hStringMapSet, long nIndex);
[in] AppConn string map list.nIndex
[in] Index of the string to get.
Method used to replace a string map in the string map list.
int ReplaceStringMapAt(StringMapSetHandle hStringMapSet, long nIndex, const StringMapHandle hStringMap);
[in] AppConn string map list.nIndex
[in] Index of the string to get.hStringMap
[in] String Map to replace the existing entry.
Method used to remove a string map from the string map list.
int RemoveStringMapAt(StringMapSetHandle hStringMapSet, long nIndex);
[in] AppConn string map list.nIndex
[in] Index of the string map to remove.
Method used to release an AppConn string map list. All elements of the string
map list are released.
int ReleaseStringMapSet(StringMapSetHandle hStringMapSet);
[in] AppConn string map list.
An integer value indicating whether or not the call succeeded (succeeded = !0, failed = 0).
Method used to get the error code for an AppConn object.
long GetErrorCode(SessionHandle hSession);
hSession
[in] AppConn object
The error code for the last reported error.
Method used to get the error message for an AppConn object.
long GetErrorMessage(SessionHandle hSession, long nIndex, CharType *strString, long nBufferLen);
hSession
[in] AppConn object
nIndex
[in] The index of the message to select.
strString
[out] Buffer to retrieve the string.
nBufferLen
[in] The length of the buffer.
The length of the message retrieved.
Obtain an Error Info handle for a given error message in the last set of reported errors.
ErrorInfoHandle GetErrorMessageInfo( SessionHandle hSession, long index );
hSession
Session handle.
Index
0-based index of the error for which information is to be obtained.
Handle for accessing error information, or NULL if the session handle is invalid,
there are no errors, or the index value is out of range.
Return the error code of a given error message.
long GetErrorMessageCode( ErrorInfoHandle hErrorInfo );
hError
ErrorInfoHandle obtained by calling GetErrorMessageInfo()
Error code, 0 if there is no error, or -1 if hError is invalid.
Return the number of parameter strings associated with an error message.
long GetErrorMessageParameterCount( ErrorInfoHandle hErrorInfo );
hErrorInfo
ErrorInfoHandle obtained by calling GetErrorMessageInfo()
Number of error parameters, of -1 if hErrorInfo is invalid.
Return a parameter string for an error message, given an index.
long GetErrorMessageParameter( ErrorInfoHandle hErrorInfo,
long index, CharType *strString, long nBufferLen );
hErrorInfo
ErrorInfoHandle obtained by calling GetErrorMessageInfo()
index
0-based index of the parameter to be obtained.
strString
Buffer to receive the parameter string.
nBufferLen
Maximum number of characters the buffer can accept.
number of characters returned, or -1 if argument(s) are invalid.
Release an ErrorInfoHandle and free resources associated with it.
int ReleaseErrorMessageInfo( ErrorInfoHandle hError );
hErrorInfo
ErrorInfoHandle obtained by calling GetErrorMessageInfo()
int - (succeeded = !0, failed = 0)
Method used to get the locale for an AppConn session. By default, this method returns -1 and internally posts an "Unknown Error" message. If the user has set a locale string by a prior to call to SetLocale(), that string is returned by GetLocale().
long GetLocale(SessionHandle hSession, CharType *strLocale, long nBufferLen);
hSession
[in] AppConn object
strLocale
[out] buffer to retrieve the locale
nBufferLen
[in] The length of the buffer.
The length of the locale retrieved.
Method used to set the locale for an AppConn object.
int SetLocale(SessionHandle hSession, const CharType *strLocale);
hSession
[in] AppConn object.
strLocale
[in] the locale.
An integer value indicating whether or not the call succeeded (succeeded = !0, failed = 0).
Method used to get the localized error message for an AppConn object.
long GetLocalizedMessage(Handle hError, long nIndex, CharType *strString, long nBufferLen);
hError Handle
[in] AppConn object.
strString
[out] buffer to retrieve the message.
nBufferLen
[in] The length of the buffer.
The length of the message retrieved.
Method used to get version information for the AppConn connector.
long GetMajorVersion(void);
The major version number.
Method used to get version information for the AppConn connector.
long GetMinorVersion(void);
The minor version number.
Method used to get the names of all variables in the Host Integrator model.
StringListHandle GetModelVariableNames(SessionHandle hSession);
hSession SessionHandle
[in] AppConn object.
strStringMapHandle
[out] buffer to retrieve the model variables.
The variable names.
One potential reason for failure is that the server session has not been established.
Method used to get the number of error messages for an AppConn object.
long GetNumMessages(SessionHandle hSession);
hSession
[in] AppConn object.
The number of error messages.
Method used to get the timeout (in seconds) of the operation.
long GetOperationTimeout(OperationMetaDataHandle hOperationMetaData);
hOperationMetaData OperationMetaDataHandle
[in] AppConn object.
The timeout.
Method used to get the length of a field.
long GetTermFieldLength(TerminalFieldHandle hTerminalField);
hTerminalField TerminalFieldHandle
[in] AppConn Terminal Field
The length of the field.
Method used to get version information for the AppConn connector.
long GetVersionString(CharType *strVersionString, long nBufferLen);
strVersionString
[in] Buffer to retrieve the version string
nBufferLen
[in] The length of the buffer.
The length of the version string retrieved.
|