TypInfo.GetWideStrProp Function

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

Pascal

function GetWideStrProp(Instance: TObject; const PropName: string): WideString; overload;
function GetWideStrProp(Instance: TObject; PropInfo: PPropInfo): WideString; overload;

C++

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

File

TypInfo

Description

GetWideStrProp utilises Delphi's RTTI (Run Time Type Information) to return the current value of a component's property where that property is a WideString type. A string or LongString type is returned via a call to the GetWideStrProp routine. Otherwise, for other types, 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 WideString.

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.