System.ConvUtils.DescriptionToConvType

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function DescriptionToConvType(const ADescription: string; out AType: TConvType): Boolean;
function DescriptionToConvType(const AFamily: TConvFamily; const ADescription: string; out AType: TConvType): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall DescriptionToConvType(const System::UnicodeString ADescription, /* out */ TConvType &AType)/* overload */;

Properties

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

Description

Retrieves the identifier for a conversion type given its name and family.

DescriptionToConvType returns the conversion type identifier for the conversion type (measurement unit) that was registered under the name specified by ADescription.

AFamily is the identifier for the conversion family supplied to the RegisterConversionType function when the conversion type was registered.

ADescription is the name supplied to the RegisterConversionType function when the conversion type was registered. Typically, it is the plural form of the measurement unit name. For example, the description for the auAcres conversion type is 'Acres'.

AType returns the identifier for the conversion type.

DescriptionToConvType returns true if it can successfully locate and return the specified conversion type, false otherwise.

See Also

Code Examples