L_DispContainerGetCellRegionHandle

Summary

Retrieves a copy of the region handle for the specified bitmap in the specified cell.

Syntax

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellRegionHandle(hCellWnd, nSubCellIndex, phRgn, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT 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.

L_HRGN * 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.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

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 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

• L_DispContainerCreate
• L_DispContainerRemoveCell
• L_DispContainerInsertCell
• L_DispContainerGetCellCount
• L_DispContainerGetWindowHandle
• L_DispContainerSetCellBitmapList
• L_DispContainerSetCellTag
• L_DispContainerGetCellProperties
• L_DispContainerGetCellPosition
• L_DispContainerRepositionCell
• L_DispContainerGetCellBitmapList
• L_DispContainerGetCellBounds
• L_DispContainerFreezeCell
• L_DispContainerSelectCell
• L_DispContainerIsCellSelected
• L_DispContainerIsCellFrozen

Topics

• Image Viewer Cells
• Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerGetRegionCallBack.