System.ConvUtils.ConvFamilyToDescription

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ConvFamilyToDescription(const AFamily: TConvFamily): string;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall ConvFamilyToDescription(const TConvFamily AFamily);

Properties

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

Description

Returns the string description of what a conversion family measures.

ConvFamilyToDescription returns the string supplied when the conversion family was registered. Typically, this string is the name of whatever it is that the conversion family measures. For example, ConvFamilyToDescription returns "Volume" when passed an argument of cbVolume.

AFamily is the TConvFamily value that represents the conversion family. This is the value that is returned by RegisterConversionFamily when the family is registered.

See Also

Code Examples