L_DispContainerGetBitmapHandle

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetBitmapHandle(hCon, nCellIndex, nSubCellIndex, pBitmap, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of a cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
pBITMAPHANDLE pBitmap;	/* pointer to a bitmap handle */
L_UINT uFlags;	/* reserved for future use */

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

Parameter	Description
hCon	Handle to the container.
nCellIndex	A zero-based index of the cell for which to get the bitmap handle.
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.
pBitmap	Pointer to the variable to be updated with the specific frame as a bitmap handle.
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

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.