GetWindowRgn
A version of this page is also available for
4/8/2010
This function obtains a copy of the window region of a window. The window region of a window is set by calling the SetWindowRgn function. The window region determines the area within the window where the system permits drawing. The system does not display any portion of a window that lies outside of the window region.
Syntax
int GetWindowRgn(
HWND hWnd,
HRGN hRgn
);
Parameters
- hWnd
Handle to the window whose window region is to be obtained.
- hRgn
Receives a handle to the window region.
Return Value
The return value specifies the type of the region that the function obtains. The following table shows some of the possible return values.
| Value | Description |
|---|---|
NULLREGION |
The region is empty. |
SIMPLEREGION |
The region is a single rectangle. |
COMPLEXREGION |
The region is more than one rectangle. |
ERROR |
An error occurred; the region is unaffected. |
Remarks
The coordinates of a window's window region are relative to the upper left corner of the window, not the client area of the window.
To set the window region of a window, call the SetWindowRgn function.
Requirements
| Header | winuser.h |
| Library | coredll.lib, Winmgr.lib |
| Windows Embedded CE | Windows CE 2.12 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |