ODBC_SQLSpecialColumns

4D - Documentation   Français   English   German   4D ODBC PRO, Command Theme List   4D ODBC PRO, Command Alphabetical List   Back   Previous   Next

version 2004


ODBC_SQLSpecialColumns (stmtID; identifierType; catalogName; schemaName; tableName; scope; nulllable) Longint

ParameterTypeDescription
stmtIDLongintStatement ID
identifierTypeLongintType of column to return
catalogNameStringCatalog name for the table
schemaNameStringSchema name for the table
tableNameStringTable name
scopeLongintMinimum required space of the rowid
nulllableLongintDetermines whether to return special columns that
can have a NULL value
Function resultLongintReturns the result of the MS ODBC API function
SQLSpecialColumns

Description

The ODBC_SQLSpecialColumns command retrieves the following information about columns within a specified table. Either the optimal set of columns that uniquely identifies a row in the table or the columns that are automatically updated when any value in the row is updated by a transaction.

stmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

identifierType is the type of column to return.

catalogName is the catalog name for the table.

schemaName is the schema name for the table.

tableName is the table name.

scope is the minimum required space of the row and can have one of the following values:

ConstantDescription
SQL_SCOPE_CURROWThe rowid is guaranteed to be valid only while positioned on
that row. A later reselect using rowid may not return a row if
the row was updated or deleted by another transaction.
SQL_SCOPE_TRANSACTIONThe rowid is guaranteed to be valid for the duration of the
current transaction.
SQL_SCOPE_SESSIONThe rowid is guaranteed to be valid for the duration of the
session (across transaction boundaries).

nullable determines whether to return special columns that can have a NULL value.

For more information, please see the SQLSpecialColumns function in the MS ODBC API at http://msdn.microsoft.com/library/en-us/odbc/htm/odbcsqlspecialcolumns.asp.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.


4D - Documentation   Français   English   German   4D ODBC PRO, Command Theme List   4D ODBC PRO, Command Alphabetical List   Back   Previous   Next