Win_PtInRect

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > Windows API >

Win_PtInRect

 

Description

 

Determines whether the specified point lies within the specified rectangle.

A point is within a rectangle if it lies on the left or top side or is within all four sides.

A point on the right or bottom side is considered outside the rectangle.

 

Syntax

 

n = Win_PtInRect(lRect, lPointApi)

 

Returns

 

Number.

If the function succeeds, the return value is nonzero.

 

Parameters

 

Name

Type

Optional

Meaning

lRect

UDT

No

RECT structure that contains the specified rectangle.

lPointApi

UDT

No

POINTAPI structure that contains the specified point.

 

Remarks

 

For additional info, please refer to MS documentation at: https://docs.microsoft.com/en-us/windows/desktop/api/winuser/nf-winuser-ptinrect

 

Restrictions

 

See also

 

Examples