OdbcSetDescField Function

Action

Modifies the value of a specified descriptor record field.

Include file

ODBC.bdh

Syntax

OdbcSetDescField( in hDescriptor : number,
                  in nRecord     : number,
                  in nIdentifier : number,
                  in sValue      : string ): boolean;

Return value

true if successful
false otherwise

Parameter	Description
hDescriptor	Descriptor handle that refers to a previously allocated descriptor information storage buffer.
nRecord	Descriptor record to modify. If any field of the descriptor header record is specified in the nIdentifier parameter, this parameter is ignored. Otherwise, this parameter should contain a number greater than or equal to 0. Descriptor records are numbered, starting at 0, with record 0 being the bookmark record.
nIdentifier	Field of the descriptor header record or descriptor parameter/column record whose value is to be modified. This parameter must be set to one of the following values: SQL_DESC_AUTO_UNIQUE_VALUE SQL_DESC_BASE_COLUMN_NAME SQL_DESC_BASE_TABLE_NAME SQL_DESC_CASE_SENSITIVE SQL_DESC_CATALOG_NAME SQL_DESC_CONCISE_TYPE SQL_DESC_DATETIME_INTERVAL_CODE SQL_DESC_DATETIME_INTERVAL_PRECISION SQL_DESC_DISPLAY_SIZE SQL_DESC_FIXED_PREC_SCALE SQL_DESC_LABEL SQL_DESC_LENGTH SQL_DESC_LITERAL_PREFIX SQL_DESC_LITERAL_SUFFIX SQL_DESC_LOCAL_TYPE_NAME SQL_DESC_NAME SQL_DESC_NULLABLE SQL_DESC_NUM_PREC_RADIX SQL_DESC_OCTET_LENGTH SQL_DESC_PARAMETER_TYPE SQL_DESC_PRECISION SQL_DESC_ROWVER SQL_DESC_SCALE SQL_DESC_SCHEMA_NAME SQL_DESC_SEARCHABLE SQL_DESC_TABLE_NAME SQL_DESC_TYPE SQL_DESC_TYPE_NAME SQL_DESC_UNNAMED SQL_DESC_UNSIGNED SQL_DESC_UPDATABLE
sValue	New value of the descriptor record field.