LBitmapWindow::GetFloaterRgn

#include "ltwrappr.h"

HRGN LBitmapWindow::GetFloaterRgn(uFloatRgnType, pRgnXForm)

L_UINT uFloatRgnType;

/* flag that indicates the type of region returned */

RGNXFORM * pRgnXForm;

/* pointer to an RGNXFORM structure */

Returns the region corresponding to a floater.

Parameter

Description

uFloatRgnType

Flag that indicates the type of region returned. Possible values are:

 

Value

Meaning

 

FLOAT_RGN_TRANS_NONE

[0] Returns a windows region in bitmap coordinates.

 

FLOAT_RGN_TRANS_FROM_WINDOW

[1] Returns a windows region relative to the client area of the window. This accounts for scroll and zoom.

 

FLOAT_RGN_TRANS_USE_XFORM

[2] Returns a windows region that is translated using pRgnXForm structure.

pRgnXForm

Pointer to a RGNXFORM structure This parameter is valid only if uFloatRgnType is FLOAT_RGN_TRANS_USE_XFORM.

Returns

NULL

No floater exists.

!NULL

Handle to the region that corresponds to the floater.

Comments

HRGN should be freed when you are finished with the region.

Required DLLs and Libraries

LTDIS
LTDLG
LTEFX
LTFIL
LTIMG
LTISI
LTSCR
LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LBitmapWindow::GetFloater, LBitmapWindow::HasFloater, LBitmapWindow::SetAutoRgnToFloater, Class Members

Example

For an example, refer to LBitmapWindow::SetAutoRgnToFloater.