LBitmapWindow::UpdateMagGlassShape
#include "ltwrappr.h"
L_INT LBitmapWindow::UpdateMagGlassShape(uMagGlassShape, hMagGlassRgn)
L_UINT uMagGlassShape; |
/* flags that indicate the magnifying glass shape */ |
L_HRGN hMagGlassRgn; |
/* handle to the Windows region */ |
Updates the Magnifying Glass shape.
Parameter |
Description |
|
uMagGlassShape |
Flags that indicate the magnifying glass shape. Possible values are: |
|
|
Value |
Meaning |
|
MAGGLASS_SHAPE_RECT |
[0] Rectangle shape of Magnifying Glass. |
|
MAGGLASS_SHAPE_ELLIPSE |
[1] Ellipse shape of Magnifying Glass. |
|
MAGGLASS_SHAPE_HRGN |
[2] User-defined shape of Magnifying Glass. |
hMagGlassRgn |
Handle to a Windows region that defines the Magnifying Glass shape. This parameter is used only if the uMagGlassShape parameter is MAGGLASS_SHAPE_HRGN. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The width and height of the Magnifying Glass will be changed according to the width and height of the passed hMagGlassRgn parameter if the uMagGlassShape parameter was set to MAGGLASS_SHAPE_HRGN.
The Magnifying Glass will stop and this function will return an error value in two cases:
1. |
If the value passed in the uMagGlassShape parameter was outside the defined values. |
2. |
If the value passed in the uMagGlassShape parameter was MAGGLASS_SHAPE_HRGN and the value passed to the hMagGlassRgn parameter was NULL. |
Required DLLs and Libraries
LTDIS |
See Also
Functions: |
LBitmapWindow::GetMagGlassOptions, LBitmapWindow::MagGlassCallBack, Class Members |
Topics: |
|
|
Example
L_INT LBitmapWindow__UpdateMagGlassShapeExample(LBitmapWindow &LeadBWnd) { L_INT nRet; HRGN hRoundRectRgn; hRoundRectRgn = CreateRoundRectRgn(0, 0, 100, 100, 25, 25); nRet = LeadBWnd.UpdateMagGlassShape(MAGGLASS_SHAPE_HRGN, hRoundRectRgn); if(nRet != SUCCESS) return nRet; DeleteRgn(hRoundRectRgn); return SUCCESS; }