L_DispContainerSetCellBitmapList

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetCellBitmapList(hCellWnd, hBitmapList, bCleanImage, uFlags)

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

Parameters

L_HWND hCellWnd

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

HBITMAPLIST hBitmapList

Handle to the list of bitmaps, which will be attached to the cell at the index specified in nCellIndex. Pass NULL to remove the current bitmap list.

Removing the current bitmap list will not free the attached image(s). The value in the bCleanImage parameter determines whether the image(s) associated with the removed bitmap list are also freed.

L_BOOL bCleanImage

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.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value Meaning
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 L_DispContainerGetCellBitmapList.
  2. Call L_DispContainerSetCellBitmapList with hBitmapList set to NULL and bCleanImage set to FALSE.
  3. Modify the bitmap list as needed.
  4. Reattach the bitmap list using L_DispContainerSetCellBitmapList.

If the cell already has a bitmap list and you call this function with hBitmapList set to another valid list of bitmaps and bCleanImage 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 bCleanImage 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

Help Version 21.0.2020.8.21
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C API Help