Help Center

CODBCStmt.GetImpRowDescRecmethod

Returns the current settings or values of multiple fields of a descriptor record.

DatabasesmethodCODBCStmt.incdocumented

Syntax

FUNCTION GetImpRowDescRec (BYVAL RecNumber AS SQLSMALLINT, BYVAL pwszName AS WSTRING PTR, BYVAL BufferLength AS SQLSMALLINT, BYVAL StringLength AS SQLSMALLINT PTR, BYVAL TypePtr AS SQLSMALLINT PTR, BYVAL SubTypePtr AS SQLSMALLINT PTR, BYVAL LengthPtr AS SQLLEN PTR, BYVAL PrecisionPtr AS SQLSMALLINT PTR, BYVAL ScalePtr AS SQLSMALLINT PTR, BYVAL NullablePtr AS SQLSMALLINT PTR) AS SQLRETURN

Parameters

NameDescription
RecNumberIndicates the descriptor record from which the application seeks information. Descriptor records are numbered from 1, with record number 0 being the bookmark record. The RecNumber argument must be less or equal to the value of SQL_DESC_COUNT. If RecNumber is less that or equal to SQL_DESC_COUNT but the row does not contain data for a column or parameter, a call to GetImpRowDesc will return the default values of the fields.
pwszNameA pointer to a buffer in which to return the SQL_DESC_NAME field for the descriptor record.
TypePtrA pointer to a buffer in which to return the value of the SQL_DESC_TYPE field for the descriptor record.
SubTypePtrFor records whose type is SQL_DATETIME or SQL_INTERVAL, this is a pointer to a buffer in which to return the value of the SQL_DESC_DATETIME_INTERVAL_CODE field.
LengthPtrA pointer to a buffer in which to return the value of the SQL_DESC_OCTET_LENGTH field for the descriptor record.
PrecisionPtrA pointer to a buffer in which to return the value of the SQL_DESC_PRECISION field for the descriptor record.
ScaleSptrA pointer to a buffer in which to return the value of the SQL_DESC_SCALE field for the descriptor record.
NullablePtrA pointer to a buffer in which to return the value of the SQL_DESC_NULLABLE field for the descriptor record.

Description

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.

Result code (GetLastResult)

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 or the the statement is in the prepared or executed state but there was no open cursor associated with it.

Reference

  • Include file CODBCStmt.inc
  • Defined in AfxNova/COdbcStmt.inc:1603
  • Documented in Databases/ODBC Classes/CODBCStmt Class.md
  • Topic: CODBCStmt Class