System.Classes.InvalidPoint

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function InvalidPoint(X, Y: Integer): Boolean;
function InvalidPoint(const At: TPoint): Boolean;
function InvalidPoint(const At: TSmallPoint): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall InvalidPoint(int X, int Y)/* overload */;

Properties

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

Description

Indicates whether a specified point is equal to (-1,-1).

The point (-1,-1) is often used, by convention, to represent an invalid set of coordinates. This convention is often employed by Windows API functions. When working with other code that uses this convention, use InvalidPoint to identify coordinate values that are invalid.

At is the point to examine.

X and Y identify the point by giving the X and Y coordinates, respectively.

InvalidPoint returns True if the specified point is (-1,-1), False otherwise.