Sign in Join
FPDoc Onlineexperiment

CompareSortKey function

In unit unicodedata

Compare two sort keys.

Declaration

pascal
function CompareSortKey(const A: TUCASortKey; const B: TUCASortKey)
: Integer; overload

Arguments

A

First key to compare.

B

Second key to compare.

Function result

A signed number determining how A and B are alphabetically ordered.

Description

CompareSortKey compares 2 sort keys A and B. It returns

  • a negative number if A comes alphabetically ordered before B.
  • Zero if A is alphabetically identical to B.
  • A positive number if A is alphabetically ordered after B.

Sort keys can be constructed from unicode strings using ComputeSortKey.

See also

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