Library: ODBC
Include: omodbc.xin
|
Returns: Numeric
An SQL return code. The following values may be returned:
- SQL_SUCCESS (the list was successfully generated).
- SQL_SUCCESS_WITH_INFO (the list was successfully generated, but a message was issued).
- SQL_ERROR (an error occurred).
- SQL_INVALID_HANDLE (the handle is invalid).
- SQL_STILL_EXECUTING (the program is still executing).
|
Declaration define external counter function SQLTables
( read-only SQL_handle_type StatementHandle,
value stream CatalogName,
value counter NameLength1,
value stream SchemaName,
value counter NameLength2,
value stream TableName,
value counter NameLength3,
value stream TableType,
value counter NameLength4 )
Purpose
Returns the list of table, catalog, or schema names stored in a specific data source. The information is returned as a result set.
Input arguments:
- StatementHandle.
- CatalogName. A search pattern is allowed if the SQL_ODBC_VERSION environment attribute is SQL_OV_ODBC3, but not if it is set to SQL_OV_ODBC2. If a driver supports catalogs for some tables but not others, such as when the driver retrieves data from different DBMSs, an empty string ("") denotes tables without catalogs.
- NameLength1. The length of CatalogName.
- SchemaName. A string-search pattern for schema names. If a driver supports schemas for some tables but not others, such as when the driver retrieves data from different DBMSs, an empty string ("") denotes tables without schemas.
- NameLength2. The length of SchemaName.
- TableName. A string-search pattern for table names.
- NameLength3. The length of TableName.
- TableType. The list of table types to match.
- NameLength4. The length of TableType.
Generated: April 21, 1999 at 2:01:19 pm
If you have any comments about this section of the documentation, send email to [email protected]
Copyright © OmniMark Technologies Corporation, 1988-1999.