Region::Exclude(constRect&) method (gdiplusheaders.h)

Article
02/22/2024

The Region::Exclude method updates this region to the portion of itself that does not intersect the specified rectangle's interior.

Syntax

Status Exclude(
  const Rect & rect
);

Parameters

rect

Reference to a rectangle to use to update this Region object.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Remarks

Examples

The following example creates a region from a path and then uses a rectangle to update the region.

VOID Example_ExcludeRect(HDC hdc)
{
   Graphics graphics(hdc);

   Point points[] = {
      Point(110, 20),
      Point(120, 30),
      Point(100, 60),
      Point(120, 70),
      Point(150, 60),
      Point(140, 10)};

   Rect rect(65, 15, 70, 45);

   GraphicsPath path;
   SolidBrush solidBrush(Color(255, 255, 0, 0));

   path.AddClosedCurve(points, 6);

   // Create a region from a path.
   Region pathRegion(&path);

   // Exclude a rectangle from the path region.
   pathRegion.Exclude(rect);

   graphics.FillRegion(&solidBrush, &pathRegion);
}

Requirements

Requirement	Value
Header	gdiplusheaders.h

Share via