TypInfo.GetAnsiStrProp Function

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

Pascal

function GetAnsiStrProp(Instance: TObject; const PropName: string): AnsiString; overload;
function GetAnsiStrProp(Instance: TObject; PropInfo: PPropInfo): AnsiString; overload;

C++

AnsiString GetAnsiStrProp(TObject * Instance, const AnsiString PropName);
AnsiString GetAnsiStrProp(TObject * Instance, PPropInfo PropInfo);

File

TypInfo

Description

GetAnsiStrProp utilises Delphi's RTTI (Run Time Type Information) to return the current value of a component's property where that property is an AnsiString. An empty string is returned if the property is not of this 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 string.

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.

Use GetPropValue to retrieve a property value where the type is unknown - it is returned in a Variant type.

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