Concept Framework 2.0 documentation Contents | Index

standard.db.sql.ODBCListTables

Name Version Deprecated
ODBCListTables version 1.0 no

Prototype:
number ODBCListTables(string catalog, string schema, string name, string type[, number connectionID])

Parameters:
catalog      Catalog name. The CatalogName argument accepts search patterns if the SQL_ODBC_VERSION environment attribute is SQL_OV_ODBC3; it does not accept search patterns if SQL_OV_ODBC2 is set. If a driver supports catalogs for some tables but not for others, such as when a driver retrieves data from different DBMSs, an empty string ("") denotes those tables that do not have catalogs.
schema      String search pattern for schema names. If a driver supports schemas for some tables but not for others, such as when the driver retrieves data from different DBMSs, an empty string ("") denotes those tables that do not have schemas.
name      String search pattern for table names.
type      List of table types to match
connectionID      the ID identifying the connection as returned by ODBCDriverConnect or ODBCConnect. If this parameter is missing, this will affect the first connection created.

Description:
Get the list of table, catalog, or schema names, and table types, stored in a specific data source. The driver returns the information as a result set.

Returns:
Return a result set handle, or null if failed.

Documented by Eduard Suica, generation time: Fri Jan 21 18:06:22 2011 GMT(c)2011 RadGs Software