UniBasic Commands Reference - Rocket Software

UniBasic Commands Reference - Rocket Software UniBasic Commands Reference - Rocket Software

rocketsoftware.com
from rocketsoftware.com More from this publisher
11.04.2013 Views

For complete details about the SQLSpecialColumns function, see the Microsoft ODBC 2.0 Programmer’s Reference and SDK Guide. Parameters The following table describes each parameter of the syntax. Parameter Description 1-852 UniBasic Commands Reference statement.env SQL statement environment. col.type Type of column to return. col.type is one of the following: SQL.BEST.ROWID – Returns the best column or set of columns that uniquely identifies a row in a table. SQL.ROWVER – Returns the column or columns that are automatically updated when any value in the row is updated by a transaction. schema Qualifier name for tablename. If a driver supports qualifiers for some tables but not others, use an empty string for tables that do not have qualifiers. owner Name of the owner of the table. If a driver supports owners for some table but not others, use an empty string for tables that do not have owners. tablename Name of the table. IDscope Minimum required scope of the row ID. IDscope is one of the following: SQL.SCOPE.CURROW – Row ID is guaranteed to be valid only while positioned on that row. SQL.SCOPE.TRANSACTION – Row ID is guaranteed to be valid for the duration of the current transaction. SQL.SCOPE.SESSION – Row ID is guaranteed to be valid for the duration of the session. null Can be one of the following: SQL.NO.NULLS – Excludes special columns that can have null values. SQL.NULLABLE – Returns special columns even if they can have null values. SQLSpecialColumns Input Variables

Return Values The following table describes the return values of the SQLSpecialColumns function. Return Value Description 0 SQL.SUCCESS 1 SQL.SUCCESS.WITH.INFO −1 SQL.ERROR −2 SQL.INVALID.HANDLE SQLSpecialColumns Return Values Results are returned as a standard result set ordered by SCOPE. The following table lists the columns in the result set. The lengths of VARCHAR columns are maximums; the actual lengths depend on the data source. To get the length of the COLUMN.NAME column, use the SQL.MAX.COLUMN.NAME.LEN option of the SQLGetInfo function. Column Name Data Type Description SCOPE Smallint Actual scope of the row ID. It contains one of the following: SQL.SCOPE.CURROW SQL.SCOPE.TRANSACTION SQL.SCOPE.SESSION The null value is returned when col.type is SQL.ROWVER. COLUMN.NAME Varchar(128) Not null DATA.TYPE Smallint Not null TYPE.NAME Varchar(128) Not null Column identifier. SQLSpecialColumns Results Either an ODBC SQL data type or a driver-specific SQL data type. Data-source-dependent data type name. SQLSpecialColumns 1-853

For complete details about the SQLSpecialColumns function, see the Microsoft<br />

ODBC 2.0 Programmer’s <strong>Reference</strong> and SDK Guide.<br />

Parameters<br />

The following table describes each parameter of the syntax.<br />

Parameter Description<br />

1-852 <strong>UniBasic</strong> <strong>Commands</strong> <strong>Reference</strong><br />

statement.env SQL statement environment.<br />

col.type Type of column to return. col.type is one of the following:<br />

SQL.BEST.ROWID – Returns the best column or set of columns that<br />

uniquely identifies a row in a table.<br />

SQL.ROWVER – Returns the column or columns that are automatically<br />

updated when any value in the row is updated by a transaction.<br />

schema Qualifier name for tablename. If a driver supports qualifiers for some<br />

tables but not others, use an empty string for tables that do not have<br />

qualifiers.<br />

owner Name of the owner of the table. If a driver supports owners for some<br />

table but not others, use an empty string for tables that do not have<br />

owners.<br />

tablename Name of the table.<br />

IDscope Minimum required scope of the row ID. IDscope is one of the<br />

following:<br />

SQL.SCOPE.CURROW – Row ID is guaranteed to be valid only while<br />

positioned on that row.<br />

SQL.SCOPE.TRANSACTION – Row ID is guaranteed to be valid for<br />

the duration of the current transaction.<br />

SQL.SCOPE.SESSION – Row ID is guaranteed to be valid for the<br />

duration of the session.<br />

null Can be one of the following:<br />

SQL.NO.NULLS – Excludes special columns that can have null values.<br />

SQL.NULLABLE – Returns special columns even if they can have null<br />

values.<br />

SQLSpecialColumns Input Variables

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!