4D Doc Center : ODBC_SQLSetDescField

Home

4D v14.1

ODBC_SQLSetDescField


ODBC_SQLSetDescField ( connectionID ; recNumber ; fieldIdentifier ; valuePtr ) -> Function result

Parameter	Type	Description
connectionID	Longint	Connection ID
recNumber	Longint	Descriptor record number
fieldIdentifier	Longint	Field of the descriptor whose value is to be set
valuePtr	Pointer	Pointer to the value to set fieldIdentifier
Function result	Longint	Returns the result of the MS ODBC API function SQLSetDescField

Description

The ODBC_SQLSetDescField command sets the value of a single field of a descriptor record.

connectionID is a valid connection ID returned by ODBC_SQLAllocConnect and a connection must be established using the ODBC_SQLConnect command.

Descriptor records are numbered from 1, with recNumber equal to 0 being the bookmark record. The recNumber argument must be less than or equal to the value of SQL_DESC_COUNT. 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_SQLSetDescField will return the default values of the fields.

recNumber is the descriptor record number.

fieldIdentifier is the field of the descriptor whose value is to be set.

valuePtr is a pointer to the variable to set fieldIdentifier.

For more information, please see the SQLSetDescField function in the MS ODBC API Reference at http://msdn.microsoft.com/en-us/library/ms713560(VS.85).aspx.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.