L_DispContainerRemoveCell

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerRemoveCell(hCon, nCellIndex, bCleanImage, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of the cell to be removed */
L_BOOL bCleanImage;	/* flag */
L_UINT uFlags;	/* reserved for future use */

Removes a cell from the container.

Parameter	Description
hCon	Handle to the container.
nCellIndex	The zero-based index of the cell to be removed. Removing the cell will not remove the attached image. The value in the bCleanImage parameter determines whether the image(s) associated with the removed cell are also freed. Pass -1 to remove all cells. Pass -2 to remove the selected cells.
bCleanImage	Flag that indicates whether to free the image(s) attached to the cell. Possible values are:
	Value	Meaning
	TRUE	Free any images attached to the cell specified in the nCellIndex parameter.
	FALSE	Do not free any images attached to the cell specified in the nCellIndex parameter. If the images are not removed, they will take up memory until the application ends.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

When a cell is removed from the image viewer, any cells to the right or below the removed cell will be automatically shifted to the left, or up, to the end of the preceding row, as needed.

To insert a new cell, call L_DispContainerInsertCell.

When the container itself is no longer needed, call the L_DispContainerDestroy function to destroy any cells within the container, any associated bitmaps, and any internal data.

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_DispContainerInsertCell, L_DispContainerGetCellCount, L_DispContainerGetCellWindowHandle, L_DispContainerSetCellBitmapList, L_DispContainerSetCellTag, L_DispContainerSetCellProperties, L_DispContainerGetCellProperties, L_DispContainerGetCellPosition, L_DispContainerRepositionCell, L_DispContainerGetCellBitmapList, L_DispContainerGetCellBounds, L_DispContainerFreezeCell, L_DispContainerSelectCell, L_DispContainerIsCellSelected, L_DispContainerIsCellFrozen, L_DispContainerDestroy
Topics:	Image Viewer Cells
	Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerCreate.