L_DispContainerGetBitmapHandle

Summary

Retrieves the bitmap handle (or frame) of the specific cell or sub-cell.

Syntax

L_LTIVW_API L_INT L_DispContainerGetBitmapHandle(hCellWnd, nSubCellIndex, pBitmap, 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. The bitmap handle of the image attached to the sub-cell at this index will be retrieved. Pass -2 to retrieve the bitmap handle of the active sub-cell.

pBITMAPHANDLE pBitmap

Pointer to the variable to be updated with the specific frame as a bitmap handle.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

This function gives the user a bitmap handle that to allow him to modify the attached bitmap using any function in the LEADTOOLS toolkit.

The user must set the bitmap handle be calling L_DispContainerSetBitmapHandle function after he is done with it. Otherwise the viewer could view unexpected results.

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_DispContainerGetCellWindowHandle
• L_DispContainerSetCellTag
• L_DispContainerSetCellProperties
• L_DispContainerGetCellProperties
• L_DispContainerGetCellPosition
• L_DispContainerRepositionCell
• L_DispContainerSetCellBitmapList
• L_DispContainerGetCellBitmapList
• L_DispContainerGetCellBounds
• L_DispContainerFreezeCell
• L_DispContainerSelectCell
• L_DispContainerIsCellSelected
• L_DispContainerIsCellFrozen
• L_DispContainerSetBitmapHandle

Topics

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

Example

For an example, refer to L_DispContainerAnnToRgn