System.StrUtils.SoundexInt

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function SoundexInt(const AText: string; ALength: TSoundexIntLength): Integer;

C++

extern DELPHI_PACKAGE int __fastcall SoundexInt(const System::UnicodeString AText, TSoundexIntLength ALength = (TSoundexIntLength)(0x4));

Properties

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

Description

Converts a string into an integer that represents its phonetic value.

SoundexInt uses a Soundex algorithm to convert the string specified by AText into a phonetic representation where each character of the resulting string represents one of six families of similar phonemes. It then returns an integer that uniquely represents the first ALength Soundex codes in that string representation.

Note: The TSoundexIntLengthLength type represents an integer between 1 and 8. This is because the size of the integer return value limits the number of Soundex codes that can be used in the final representation.

See Also