SQLTABLES()
From Lianjapedia
Purpose
Store data source table names to a table
Syntax
SQLTABLES(<nStatementHandle>[, <cTableTypes>] [, <cCursorName>])
See Also
SQLCANCEL(), SQLCOLUMNS(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLGETPROP(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLSTRINGCONNECT(), SQLTRANSACTION()
Description
The SQLTABLES() function is used to store table name information for a specified connection to a table.
The SQLTABLES() function operates on the data source specified by <nStatementHandle>.
Keywords | Description |
---|---|
nStatementHandle | Statement handle to the connection |
cTableType | The table type or types to include. ’TABLE’, ’VIEW’ and ’SYSTEM_TABLE’ are all valid table types. If cTableType is omitted or empty, all types of table are included |
cCursorName | The name of the table to create. If cCursorName is not specified, the default name SQLRESULT is used. The table column information is shown in the table below |
cCursorName Table Columns:
Column | Description |
---|---|
TABLE_QUALIFIER | Table qualifier id |
TABLE_OWNER | Table owner id |
TABLE_NAME | Table name |
TABLE_TYPE | Table type |
REMARKS | Table description |
Return values:
Return Value | Description |
---|---|
1 | The cursor was created successfully |
0 | SQLTABLES() still executing |
Example
nStatHand = sqlstringconnect("awhr2") if nStatHand < 1 messagebox("Could not connect") else // Store names for all table types to default results table nTabEnd = sqltables(nStatHand) if nTabEnd = 1 select sqlresult list endif endif nStatHand = sqlstringconnect("Driver={SQL Server};Server=USER-PC\INST1;Trusted_Connection=yes;Database=AdventureWorks;") if nStatHand < 1 messagebox("Could not connect") else // Store names for specified table types to specified results table nTabEnd = sqltables(nStatHand, "'TABLE','VIEW'", "myresults") if nTabEnd = 1 select myresults list endif endif