CWnd::SetWindowRgn

Call this member function to set a window's region.

int SetWindowRgn(
   HRGN hRgn,
   BOOL bRedraw 
);

Parameters

  • hRgn
    A handle to a region.

  • bRedraw
    If TRUE, the operating system redraws the window after setting the region; otherwise, it does not. Typically, set bRedraw to TRUE if the window is visible. If set to TRUE, the system sends the WM_WINDOWPOSCHANGING and WM_WINDOWPOSCHANGED messages to the window.

Return Value

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.

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.

After a successful call to SetWindowRgn, the operating system owns the region specified by the region handle hRgn. The operating system does not make a copy of the region, so do not make any further function calls with this region handle, and do not close this region handle.

Requirements

Header: afxwin.h

See Also

Concepts

CWnd Class

CWnd Members

Hierarchy Chart

SetWindowRgn

CWnd::GetWindowRgn