CRgn::FromHandle

Syntax

static CRgn* FromHandle( HRGN hRgn );

Parameters

hRgn

Specifies a handle to a Windows region.

Remarks

Returns a pointer to a CRgn object when given a handle to a Windows region. If a CRgn object is not already attached to the handle, a temporary CRgn object is created and attached. This temporary CRgn object is valid only until the next time the application has idle time in its event loop, at which time all temporary graphic objects are deleted. Another way of saying this is that the temporary object is only valid during the processing of one window message.

Return Value

A pointer to a CRgn object. If the function was not successful, the return value is NULL.