ComparePoints function

Declaration

function ComparePoints(p1: TPoint; p2: TPoint): Integer

Arguments

Function result

Relative order for the compared points. -1, 0, or 1.

Description

ComparePoints is an Integer function used to compare the coordinates in the specified TPoint instances to determine their relative order. The return value contains -1, 0, or 1 for the following conditions:

-1

p1.y is smaller than p2.y, or p1.x is smaller than p2.x.

0

p1 and p2 have the same x and y values.

1

p1.y is larger than p2.y, or p1.x is larger than p2.x.

ComparePoints is used in the implementation of the TCustomSynEdit / TSynEdit control.

Added in LCL version 4.3.

See also

• TPoint