Sign in Join
FPDoc Onlineexperiment

GetPropValue function

In unit Variants

Return a property value as a variant.

Declaration

pascal
function GetPropValue(Instance: TObject; PropInfo: PPropInfo; 
 PreferStrings: Boolean): Variant; overload

Arguments

Instance

Instance from which to get property value.

PropInfo

Pointer to property information (RTTI).

PreferStrings

Try to cast to string.

Function result

Property value as variant.

Description

GetPropValue returns the value of the property described by PropInfo from the Instance. The property value is returned as a variant type.

when PreferStrings is true, the implementation will tend to cast to a string-valued variant when a conversion must be done.

This function is used as the value for the TypInfo unit's OnGetPropValue callback. This callback is automatically initialized with the function when the variants unit is used.

See also

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