SubtractRect

This function obtains the coordinates of a rectangle determined by subtracting one rectangle from another.

At a Glance

Header file: Winuser.h
Windows CE versions: 1.0 and later

Syntax

BOOL SubtractRect(LPRECT lprcDst, const RECT *lprcSrc1,
const
RECT *lprcSrc2);

Parameters

lprcDst

Long pointer to a RECT structure that receives the coordinates of the rectangle determined by subtracting the rectangle pointed to by lprcSrc2 from the rectangle pointed to by lprcSrc1.

lprcSrc1

Long pointer to a RECT structure from which the function subtracts the rectangle pointed to by lprcSrc2.

lprcSrc2

Long pointer to a RECT structure that the function subtracts from the rectangle pointed to by lprcSrc1.

Return Values

Nonzero indicates success. Zero indicates failure.

To get extended error information, call GetLastError.

Remarks

The function only subtracts the rectangle specified by lprcSrc2 from the rectangle specified by lprcSrc1 when the rectangles intersect completely in either the x- or y-direction. For example, if *lprcSrc1 has the coordinates (10,10,100,100) and *lprcSrc2 has the coordinates (50,50,150,150), the function sets the coordinates of the rectangle pointed to by lprcDst to (10,10,100,100). If *lprcSrc1 has the coordinates (10,10,100,100) and *lprcSrc2 has the coordinates (50,10,150,150), however, the function sets the coordinates of the rectangle pointed to by lprcDst to (10,10,50,100).

See Also

IntersectRect, RECT, UnionRect