SQLColAttributes
Full Description
swirl
Syntax
  define external counter function SQLColAttributes
     (  read-only SQL_handle_type StatementHandle,
        value counter ColumnNumber,
        value counter FieldIdentifier,
        modifiable stream CharacterAttribute,
        value counter BufferLength,
        modifiable counter StringLength,
        modifiable counter NumericAttribute )


Purpose

Returns descriptor information for a column in a result set. The SQLColAttributes external function can't be used to return information about the bookmark column (column 0). Descriptor information is returned as a character string, a 32-bit descriptor-dependent value, or an integer value. This function has been superseded by SQLColAttribute in ODBC 3.0.

Input arguments:

  1. StatementHandle.
  2. ColumnNumber. The column number of the result data, starting at 1.
  3. FieldIdentifier. A valid descriptor type. The following values are allowed:
    • SQL_COLUMN_COUNT
    • SQL_COLUMN_NAME
    • SQL_COLUMN_TYPE
    • SQL_COLUMN_LENGTH
    • SQL_COLUMN_PRECISION
    • SQL_COLUMN_SCALE
    • SQL_COLUMN_DISPLAY_SIZE
    • SQL_COLUMN_NULLABLE
    • SQL_COLUMN_UNSIGNED
    • SQL_COLUMN_MONEY
    • SQL_COLUMN_UPDATABLE
    • SQL_COLUMN_AUTO_INCREMENT
    • SQL_COLUMN_CASE_SENSITIVE
    • SQL_COLUMN_SEARCHABLE
    • SQL_COLUMN_TYPE_NAME
    • SQL_COLUMN_TABLE_NAME
    • SQL_COLUMN_OWNER_NAME
    • SQL_COLUMN_QUALIFIER_NAME
    • SQL_COLUMN_LABEL
  4. BufferLength. The length of the data buffer, in bytes.

Output arguments:

  • CharacterAttribute. The value in the FieldIdentifier field, if it is character data.
  • StringLength. The number of bytes returned in CharacterAttribute.
  • NumericAttribute. The value in the FieldIdentifier field, if it is numeric data.

Copyright © OmniMark Technologies Corporation, 1988-1998.