System.StrUtils.SoundexCompare

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function SoundexCompare(const AText, AOther: string; ALength: TSoundexLength): Integer;

C++

extern DELPHI_PACKAGE int __fastcall SoundexCompare(const System::UnicodeString AText, const System::UnicodeString AOther, TSoundexLength ALength = (TSoundexLength)(0x4));

Properties

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

Description

Compares the Soundex representations of two strings.

SoundexCompare uses a Soundex algorithm to convert the strings specified by AText and AOther into phonetic representations where each character of the resulting string represents one of six families of similar phonemes. It then compares the first ALength characters of the resulting representations by calling AnsiCompareStr.

SoundexCompare returns 0 if the first ALength characters of the phonetic representations are identical, a value less then 0 if the representation of AText is less than the representation of AOther, and a value greater than 0 if the representation of AText is greater than the representation of AOther.

See Also