ODBC_SQLGetDescRec

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

version 2004


ODBC_SQLGetDescRec (stmtID; recNumber; name; type; subType; length; precision; scale; nullable) Longint

ParameterTypeDescription
stmtIDLongintStatement ID
recNumberIntegerDescriptor record number
nameStringSQL_DESC_NAME field for the descriptor record
typeLongintSQL_DESC_TYPE field for the descriptor record
subTypeLongintSQL_DESC_DATETIME_INTERVAL_CODE field for
the descriptor record
lengthLongintSQL_DESC_OCTET_LENGTH field for the descriptor
record
precisionLongintSQL_DESC_PRECISION field for the descriptor record
scaleLongintSQL_DESC_SCALE field for the descriptor record
nullableLongintSQL_DESC_NULLABLE field for the descriptor record
Function resultLongintReturns the result of the MS ODBC API function
SQLGetDescRec

Description

The ODBC_SQLGetDescRec command returns the current settings or values of multiple fields of a descriptor record. The fields returned describe the name, data type, and storage of column or parameter data.

StmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

Descriptor records are numbered from 0, with record number 0 being the bookmark record. If the fieldIdentifier argument indicates a header field, recNumber is ignored. If RecNumber is less than or equal to SQL_DESC_COUNT but the row does not contain data for a column or parameter, a call to ODBC_SQLGetDescField will return the default values of the fields.

recNumber is the descriptor record number.

name is the SQL_DESC_NAME field for the descriptor record.

type is the SQL_DESC_TYPE field for the descriptor record.

subType is the SQL_DESC_DATETIME_INTERVAL_CODE field for the descriptor record (for records whose type is SQL_DATETIME or SQL_INTERVAL).

length is the SQL_DESC_OCTET_LENGTH field for the descriptor record.

precision is the SQL_DESC_PRECISION field for the descriptor record.

scale is the SQL_DESC_SCALE field for the descriptor record.

nullable is the SQL_DESC_NULLABLE field for the descriptor record.

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

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR, or SQL_INVALID_HANDLE.

See Also

ODBC_SQLSetDescRec.


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