Sign in Join
FPDoc Onlineexperiment

VarTypeIsValidElementType function

In unit Variants

Check if a variant type can be used in an array.

Declaration

pascal
function VarTypeIsValidElementType(const aVarType: tvartype): Boolean

Arguments

aVarType

Type to test.

Function result

True if the variant type aVarType can be used in an array.

Description

VarTypeIsValidElementType checks if the variant type aVarType can be used as the type of a variant array, similar to VarTypeIsValidArrayType. It returns True if it is usable, False otherwise. Currently, the following types are valid: SmallInt, Integer, Single, Double, Date, Currency, OleStr, Dispatch, Error, Boolean, Variant, Unknown (interface IUnknown), ShortInt, Byte, Word, LongWord int64. In addition, if the variant type is an known custom variant type, True is also returned.

Reference and array indicators are stripped before the test.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.