LImageViewerCell::SetCellBitmapList

#include "ltwrappr.h"

L_INT LImageViewerCell::SetCellBitmapList (hBitmapList, bCleanImages, uFlags);

HBITMAPLIST hBitmapList;	/* handle to the list of bitmaps */
L_BOOL bCleanImages;	/* free the bitmap list flag */
L_UINT uFlags;	/* reserved for future use */

Attaches a bitmap list to the cell at the specified index.

Parameter	Description
hBitmapList	Handle to the list of bitmaps, which will be attached to the cell. Pass NULL to remove the current bitmap list. Removing the current bitmap list will not free the attached image(s). The value in the bCleanImages parameter determines whether the image(s) associated with the removed bitmap list are also freed.
bCleanImages	Flag that specifies whether to free the bitmap list that was previously attached to the cell. Possible values are:
	Value	Meaning
	TRUE	Free the bitmap list that was previously attached to the cell.
	FALSE	Do not free the bitmap list that was previously attached to the cell.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

It is best not to modify an existing bitmap list attached to a specific cell. However, if it is necessary to modify an attached bitmap list, follow the steps below:

1.	Get the bitmap list using the function LImageViewerCell::GetCellBitmapList.
2.	Call LImageViewerCell::SetCellBitmapList with hBitmapList set to NULL and bCleanImages set to FALSE.
3.	Modify the bitmap list as needed.
4.	Reattach the bitmap list using LImageViewerCell::SetCellBitmapList.

If the cell already has a bitmap list and you call this function with hBitmapList set to another valid list of bitmaps and bCleanImages set to TRUE, this function frees the current attached list and attaches the new list to the cell.

If the cell already has a bitmap list and you call this function with hBitmapList set to another valid list of bitmaps and bCleanImages set to FALSE, this function will just overwrite the current list of bitmap with the new list of bitmaps. and the current list will just take up memory until the application ends.

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:	LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::GetCellWindowHandle, LImageViewerCell::SetCellTag, LImageViewerCell::SetCellProperties, LImageViewerCell::GetCellProperties, LImageViewer::GetCellPosition, LImageViewer::RepositionCell, LImageViewerCell::GetCellBitmapList, LImageViewerCell::GetCellBounds, LImageViewerCell::FreezeCell, LImageViewerCell::SelectCell, LImageViewerCell::IsCellSelected, LImageViewerCell::IsCellFrozen, Class Members
Topics:	Image Viewer Cells
	Window Control/Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to LImageViewer::Create.