UniBasic Commands Reference - Rocket Software
UniBasic Commands Reference - Rocket Software UniBasic Commands Reference - Rocket Software
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
- Page 844 and 845: Parameter Description Return Values
- Page 846 and 847: Parameter Description Return Values
- Page 848 and 849: Return Values The following table d
- Page 850 and 851: ODBC Data Sources When a program is
- Page 852 and 853: SQLExecDirect Syntax status = SQLEx
- Page 854 and 855: Parameter Description Return Values
- Page 856 and 857: SQLExecute tells the data source to
- Page 858 and 859: Return Values The following table d
- Page 860 and 861: Return Values The following table d
- Page 862 and 863: Return Values The following table d
- Page 864 and 865: Parameters The following table desc
- Page 866 and 867: SQLGetInfo Syntax status = SQLGetIn
- Page 868 and 869: 1-826 UniBasic Commands Reference S
- Page 870 and 871: Return Values The following table l
- Page 872 and 873: Parameters The following table desc
- Page 874 and 875: 1-832 UniBasic Commands Reference C
- Page 876 and 877: SQLNumParams Syntax status = SQLNum
- Page 878 and 879: SQLNumResultCols Syntax status = SQ
- Page 880 and 881: SQLParamOptions Syntax status = SQL
- Page 882 and 883: Example This example shows how you
- Page 884 and 885: ODBC Data Sources If you execute a
- Page 886 and 887: SQLRowCount Syntax status = SQLRowC
- Page 888 and 889: SQLSetConnectOption Syntax status =
- Page 890 and 891: Return Values The following table d
- Page 892 and 893: SQLSetParam SQLSetParam is a synony
- Page 896 and 897: 1-854 UniBasic Commands Reference C
- Page 898 and 899: Parameter Description tablename Nam
- Page 900 and 901: TYPE Smallint Not null 1-858 UniBas
- Page 902 and 903: SQLTables Syntax status = SQLTables
- Page 904 and 905: Return Values The following table d
- Page 906 and 907: Parameters The following table desc
- Page 908 and 909: SQRT Syntax SQRT(num.expr) Descript
- Page 910 and 911: SSUB Syntax SSUB(x, y) Description
- Page 912 and 913: STOP Syntax STOP [expr] Description
- Page 914 and 915: STR Syntax STR(str.expr, num.expr)
- Page 916 and 917: STRS Syntax STRS(dyn.array, expr) D
- Page 918 and 919: If the response status indicates th
- Page 920 and 921: SUBROUTINE Syntax SUBROUTINE sub.na
- Page 922 and 923: SUBROUTINE (Update Trigger) Syntax
- Page 924 and 925: Tip: The UniBasic STATUS function r
- Page 926 and 927: SUBROUTINE (Delete Trigger) Syntax
- Page 928 and 929: Tip: The UniBasic STATUS function r
- Page 930 and 931: Related Commands UniBasic DEL, INSE
- Page 932 and 933: Examples In the following example,
- Page 934 and 935: In the next example, SWAP does not
- Page 936 and 937: Parameter Description 1-894 UniBasi
- Page 938 and 939: Parameter Description 1-896 UniBasi
- Page 940 and 941: TAN Syntax TAN(num.expr) Descriptio
- Page 942 and 943: TIMEDATE Syntax TIMEDATE( ) Descrip
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