#include "l_bitmap.h"
L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellRegionHandle(hCellWnd, nSubCellIndex, phRgn, uFlags)
L_HWND hCellWnd; |
handle to the cell window |
L_INT nSubCellIndex; |
index into the image list attached to the cell |
L_HRGN * phRgn; |
address of the variable to be updated |
L_UINT uFlags; |
reserved for future |
Retrieves a copy of the region handle for the specified bitmap in the specified cell.
Parameter |
Description |
hCellWnd |
A handle to the window that represents the cell on which the function's effect will be applied. |
nSubCellIndex |
A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell contains the image that contains the bitmap region that needs to be retrieved. Pass -2 to refer to the selected sub-cell. |
phRgn |
Pointer to the Windows region handle. You do not have to create the region. You just declare the HRGN variable and pass its address. |
uFlags |
Reserved for future use. Pass 0. |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
You should delete the region handle once it is no longer needed using the windows function DeleteObject.
This function gets the cell region handle. To set the bitmap region handle, use L_DispContainerSetCellRegionHandle.
Required DLLs and Libraries
LTIVW |
For an example, refer to L_DispContainerGetRegionCallBack.