Library: ODBC
Include: omodbc.xin
|
Returns: Numeric
An SQL return code. The following values may be returned:
- SQL_SUCCESS (the statistics were successfully retrieved).
- SQL_SUCCESS_WITH_INFO (the statistics were successfully retrieved, 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 SQLStatistics
( 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 counter Unique,
value counter Reserved )
Purpose
Retrieves statistics on a single table and its associated indexes. The information is returned as a result set.
Input arguments:
- StatementHandle.
- CatalogName. 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. CatalogName cannot contain a string-search pattern.
- 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. SchemaName cannot contain a string-search pattern.
- NameLength2. The length of SchemaName.
- TableName. A string-search pattern for table names. TableName cannot contain a string-search pattern.
- NameLength3. The length of TableName.
- Unique. A type of index. The following values are allowed: SQL_INDEX_UNIQUE and SQL_INDEX_ALL.
- Reserved. This indicates the importance of the CARDINALITY and PAGES columns in the result set.The following values are allowed: SQL_QUICK and SQL_ENSURE. These values affect the return of the CARDINALITY and PAGES column only; index information is returned even if CARDINALITY and PAGES are not returned.
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.