FieldInfo (ODBCResultSet - LotusScript)
Returns an array of field information.
Defined in
Syntax
infoArray = odbcResultSet . FieldInfo( column_id% )
or
infoArray = odbcResultSet . FieldInfo( column_Name$ )
Parameters
column_id%
Integer. The ID of the column. Use any numeric data type, except Currency.
column_Name$
String. The name of the column.
Return value
infoArray
Array with elements as follows:
|
DB_INFO_AUTOINCREMENT |
Boolean. Returns True if column value is automatically incremented (a serial number). |
|---|---|
|
DB_INFO_CASESENSITIVE |
Boolean. Returns True if column value is case sensitive. A search is performed in a case-sensitive manner. |
|
DB_INFO_COLUMNID |
String. Contains the column ID. This is an ordinal value identifying the relative position in the result set of this column. The value is also returned by FieldID. |
|
DB_INFO_COLUMNNAME |
String. Contains the column name. If the column is computed, the automatic name Computed1, Computed2, and so forth, is generated. This name is also returned by FieldName. |
|
DB_INFO_COMPUTED |
Boolean. True if the column is computed. |
|
DB_INFO_DISPLAYSIZE |
Integer. Value is maximum display size in characters, not bytes. |
|
DB_INFO_EXPECTED_DATATYPE |
Integer. The expected data type is the translation data type for this column. For actual values and additional information, see the FieldExpectedDataType method. |
|
DB_INFO_LENGTH |
Integer. Value returned in FieldSize. |
|
DB_INFO_MONEY |
Boolean. True if the column value represents money or currency. |
|
DB_INFO_NATIVE_DATATYPE |
Integer. Contains the native data type for the referenced column. The native data type is the data type of the field as stored in the database and may be any of the types described in FieldNativeDataType. |
|
DB_INFO_NULLABLE |
Integer. One of the following: DB_NO_NULLS (cannot accept null); DB_NULLABLE (can accept null); DB_NULLS_UNKNOWN (unknown null status). |
|
DB_INFO_PRECISION |
Integer. The back-end precision value. |
|
DB_INFO_READONLY |
Integer. Read-only status at the back-end; does not reflect local protection granted by the ReadOnly property. One of the following: DB_READWRITE; DB_READONLY (back-end protected or computed); DB_READONLY_UNKNOWN. |
|
DB_INFO_SCALE |
Integer. Number of places after the decimal point. Value is valid only for real or float values; zero otherwise. |
|
DB_INFO_SEARCHABLE |
Integer. One of the following: DB_UNSEARCHABLE (cannot be part of Where clause); DB_LIKE_ONLY (can be used in a Where clause only with Like); DB_ALLEXCEPT_LIKE (can be used, but without Like); DB_SEARCHABLE (can be used in a Where clause). |
|
DB_INFO_SETTABLE |
Boolean. False means that SetValue fails because the column is read-only, the database is read-only, read-only has been set by ReadOnly, or the column is computed and cannot be updated. True means that SetValue does not fail but UpdateRow may fail; for example, a unique value is required, some arguments are invalid, the original row is locked or has changed, or other reasons. |
|
DB_INFO_SQLDATATYPE |
Integer. Contains the native data type for the referenced column. The native data type is the data type of the field as stored in the database and may be any of the types described in FieldNativeDataType. |
|
DB_INFO_TABLENAME |
String. Contains the table name for the column. If the column is computed or if the column is an aggregate and is not part of any table, no table name is supplied -- that is, the null string is returned. |
|
DB_INFO_UNSIGNED |
Boolean. True if the column value is unsigned. For integer and long, this means that the value has no sign. |
Usage
Reports characteristics of a field. Not all data sources have all the characteristics, but the ODBC standard requires that the driver report them all.
Errors
Field id is out of range (DBstsINVC)