System.ConvUtils.DescriptionToConvFamily

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function DescriptionToConvFamily(const ADescription: string; out AFamily: TConvFamily): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall DescriptionToConvFamily(const System::UnicodeString ADescription, /* out */ TConvFamily &AFamily);

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 family given its name.

DescriptionToConvFamily retrieves the conversion family identifier for the family with the name specified by ADescription.

ADescription is the name supplied to the RegisterConversionFamily method when the family was registered. Typically, it identifies the type of thing measured by conversion types in the family. For example, the description for the cbTemperature family is 'Temperature'.

AFamily returns the identifier for the specified conversion family when DescriptionToConvFamilyt returns true.

DescriptionToConvFamily returns true if ADescription identifies a registered conversion family, false otherwise.

See Also

Code Examples