System.TypInfo.GetVariantProp

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function GetVariantProp(Instance: TObject; const PropName: string): Variant;
function GetVariantProp(Instance: TObject; PropInfo: PPropInfo): Variant;

C++

extern DELPHI_PACKAGE System::Variant __fastcall GetVariantProp(System::TObject* Instance, const System::UnicodeString PropName)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.TypInfo.pas
System.TypInfo.hpp
System.TypInfo System.TypInfo

Description

Returns the value of a component property that is a variant type.

GetVariantProp utilises Object Pascal's RTTI (Run Time Type Information) to return the current value of a component's property that is a variant type.

In one form of this function, the object Instance's property is defined by a PropInfo record. GetPropInfo and GetPropList can be used to obtain such a record.

In the other form of this function, the name of the property, PropName, is explicitly given.

In both forms of the function, the current value of the property is returned as a variant.

The intrinsic value of this function is to allow retrieval of component properties without the need to hard code the property name. This allows mass visual component processing at run time.

Note: If the specified property does not exist, or is not a published property, an EPropertyError exception is thrown. If the property is not a variant type, an EVariantBadVarTypeError exception is thrown.

See Also