Full text search
function	SQLGetDescField

Library: ODBC Include: omodbc.xin

Returns: Numeric An SQL return code. The following values may be returned: SQL_SUCCESS (the current field setting). SQL_SUCCESS_WITH_INFO (the current field setting, but a message was issued). SQL_ERROR (an error occurred). SQL_INVALID_HANDLE (the handle is invalid). SQL_NO_DATA (no data is available).

Declaration

  define external counter function SQLGetDescField
     (  read-only SQL_handle_type DescriptorHandle,
        value counter RecNumber,
        value counter FieldIdentifier,
        read-only SQL_vector_type Value,
        value counter BufferLength,
        modifiable counter StringLength )

Returns the current setting of a single field of a descriptor record.

Input arguments:

1. DescriptorHandle.
2. RecNumber. Indicates the descriptor record from which the application seeks information. Descriptor records are numbered from zero; record number 0 is the bookmark record. If the FieldIdentifier argument indicates a header field, RecNumber is ignored. If the row does not contain data for a column or parameter, the default values of the field are returned.
3. FieldIdentifier. Indicates the field of the descriptor whose value is to be returned. 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. The requested descriptor information.
5. BufferLength. The maximum length of Value.

Output argument:

• StringLength. The returned length of Value.