Full text search
function	SQLSetDescField

Library: ODBC Include: omodbc.xin

Returns: Numeric An SQL return code. The following values may be returned: SQL_SUCCESS (the field value was successfully set). SQL_SUCCESS_WITH_INFO (the field value was successfully set, but a message was issued). SQL_ERROR (an error occurred). SQL_INVALID_HANDLE (the handle is invalid).

Declaration

  define external counter function SQLSetDescField
     (  read-only SQL_handle_type DescriptorHandle,
        value counter RecNumber,
        value counter FieldIdentifier,
        read-only SQL_Vector_type Value,
        value counter BufferLength,
        value counter ValueType )

Sets the value of a single field of a descriptor record.

Input arguments:

1. DescriptorHandle.
2. RecNumber. Indicates the descriptor record containing the field that the application seeks to set. Descriptor records are numbered from zero; record number 0 is the bookmark record. The RecNumber argument is ignored for header fields.
3. FieldIdentifier.The field of the descriptor to be set. The following values are allowed:
   • SQL_DESC_COUNT
   • SQL_DESC_TYPE
   • SQL_DESC_LENGTH
   • SQL_DESC_OCTET_LENGTH_PTR
   • SQL_DESC_PRECISION
   • SQL_DESC_SCALE
   • SQL_DESC_DATETIME_INTERVAL_CODE
   • SQL_DESC_NULLABLE
   • SQL_DESC_INDICATOR_PTR
   • SQL_DESC_DATA_PTR
   • SQL_DESC_NAME
   • SQL_DESC_UNNAMED
   • SQL_DESC_OCTET_LENGTH
   • SQL_DESC_ALLOC_TYPE
   • SQL_DESC_ARRAY_SIZE
   • SQL_DESC_ARRAY_STATUS_PTR
   • SQL_DESC_BASE_COLUMN_NAME
   • SQL_DESC_BASE_TABLE_NAME
   • SQL_DESC_BIND_OFFSET_PTR
   • SQL_DESC_BIND_TYPE
   • SQL_DESC_DATETIME_INTERVAL_PRECISION
   • SQL_DESC_LITERAL_PREFIX
   • SQL_DESC_LITERAL_SUFFIX
   • SQL_DESC_LOCAL_TYPE_NAME
   • SQL_DESC_MAXIMUM_SCALE
   • SQL_DESC_MINIMUM_SCALE
   • SQL_DESC_NUM_PREC_RADIX
   • SQL_DESC_PARAMETER_TYPE
   • SQL_DESC_ROWS_PROCESSED_PTR
4. Value. A pointer to a buffer containing the descriptor information.
5. BufferLength. The length of Value.
6. ValueType. The type of data specified in Value. The following values are allowed: SQL_CHAR and SQL_INTEGER.