Sign in Join
FPDoc Onlineexperiment

Soundex function

In unit StrUtils

Compute the soundex of a string.

Declaration

pascal
function Soundex(const AText: string; ALength: TSoundexLength): string

Arguments

AText

Text to compute soundex of.

ALength

Length of the soundex.

Function result

String with the soundex code of the original string.

Description

Soundex computes a soundex code for AText. The resulting code will at most have ALength characters. The soundex code is computed according to the US system of soundex computing, which may result in inaccurate results in other languages.

Note that AText may not contain null characters.

Errors

None.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.