4D v13

ODBC_SQLGetDescField

Home

 
4D v13
ODBC_SQLGetDescField

ODBC_SQLGetDescField 


 

ODBC_SQLGetDescField ( connectionID ; recNumber ; fieldIdentifier ; valuePtr ) -> Function result 
Parameter Type   Description
connectionID  Longint in Connection ID
recNumber  Longint in Descriptor record number
fieldIdentifier  Longint in Field of the descriptor whose value is to be returned
valuePtr  Pointer in Pointer to a variable to receive the descriptor information
Function result  Longint in Returns the result of the MS ODBC API function SQLGetDescField

The ODBC_SQLGetDescField command returns the current setting or 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 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.

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

valuePtr is a pointer to the variable in which to receive the descriptor information.

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

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA, or SQL_INVALID_HANDLE.

SQL_NO_DATA is returned if recNumber is greater than the current number of descriptor records.

 
PROPERTIES 

Product: 4D
Theme: ODBC_Results
Number: 16957

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D ODBC Pro 2004

 
SEE ALSO 

ODBC_SQLSetDescField