4D v13

ODBC_SQLSpecialColumns

Home

 
4D v13
ODBC_SQLSpecialColumns

ODBC_SQLSpecialColumns 


 

ODBC_SQLSpecialColumns ( stmtID ; identifierType ; catalogName ; schemaName ; tableName ; scope ; nulllable ) -> Function result 
Parameter Type   Description
stmtID  Longint in Statement ID
identifierType  Longint in Type of column to return
catalogName  String in Catalog name for the table
schemaName  String in Schema name for the table
tableName  String in Table name
scope  Longint in Minimum required space of the rowid
nulllable  Longint in Determines whether to return special columns that can have a NULL value
Function result  Longint in Returns the result of the MS ODBC API function SQLSpecialColumns

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 Reference at http://msdn.microsoft.com/en-us/library/ms714602(VS.85).aspx.

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.

 
PROPERTIES 

Product: 4D
Theme: ODBC_Catalog functions
Number: 16940

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D ODBC Pro 2004