Admin Production ni-theme
Current Publication

RectContainsRect

LabWindows/CVI

RectContainsRect

int RectContainsRect (Rect containerRect, Rect containedRect);

Purpose

Returns 1 if the first rectangle you specify encloses the second rectangle you specify. The function returns 0 otherwise.

A rectangle is considered to enclose another rectangle if every point of the second rectangle is in the interior or on the frame of the first rectangle. A rectangle encloses itself.

Parameters

Input
Name Type Description
containerRect Rect The rectangle tested to determine whether it encloses another rectangle.
containedRect Rect The rectangle tested to determine whether it is enclosed by another rectangle.

Return Value

Name Type Description
containsRect int Indicates if containerRect encloses containedRect.

Code Description
1 The first rectangle encloses the second rectangle.
0 The first rectangle does not enclose the second rectangle.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later