GetConnList

(ODBC Manager Library)

Description: Called to obtain a list of the available connections. The list will be returned in the form of two pointers: one for an array of the connection objects and the other for an array of the connection names.
Returns: Numeric. The connection list will be passed back in the parameters.
Usage: Script or steady state.
Related to: AddConnection | BuildDelete | BuildInsert | BuildSelect | BuildUpdate | ConvertToDbDate | ConvertToDbTime | ConvertToDbTimeStamp | ConvertToVTSDate | ConvertToVTSTime | ConvertToVTSTimeStamp | CopyRecords | DBDropList | DBGridList | ErrMessage | ExecuteQuery | ExecuteQueryCachedFlushCache | FormatBatchQuery | GetConnListResultFormat | StatsWin | TableSynch | Transaction | TransactionCached
Format: \ODBCManager\GetConnList(ObjPtr, NamePtr)
Parameters:  
ObjPtr
Required. The list of object values to return.
NamePtr
Required. The list of names to return.
Comments:

This module is a member of the ODBCManager Library, and must therefore be prefaced by \ODBCManager\, as shown in "Format" above.
Returns 0 upon completion.


The module may be called as a subroutine in a script or as a called function in a state. When called in a state, there is no automatic updating of the connection list as it changes.