4D Doc Center : ODBC_SQLSpecialColumns

4D v13

ODBC_SQLSpecialColumns


ODBC_SQLSpecialColumns ( stmtID ; identifierType ; catalogName ; schemaName ; tableName ; scope ; nulllable ) -> Function result

Parameter	Type	Description
stmtID	Longint	Statement ID
identifierType	Longint	Type of column to return
catalogName	String	Catalog name for the table
schemaName	String	Schema name for the table
tableName	String	Table name
scope	Longint	Minimum required space of the rowid
nulllable	Longint	Determines whether to return special columns that can have a NULL value
Function result	Longint	Returns 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:

Constant	Description
SQL_SCOPE_CURROW	The 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_TRANSACTION	The rowid is guaranteed to be valid for the duration of the current transaction.
SQL_SCOPE_SESSION	The 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 Reference at http://msdn.microsoft.com/en-us/library/ms714602(VS.85).aspx.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.