LImageViewerCell::SetCellRegionHandle

#include "ltwrappr.h"

L_INT LImageViewerCell::SetCellRegionHandle(nSubCellIndex, hRgn, uCombineMode, uFlags)

L_INT nSubCellIndex;	/* index into the image list attached to the cell */
L_HRGN hRgn;	/* handle to the Windows region */
L_UINT uCombineMode;	/* action to take regarding the existing region */
L_UINT uFlags;	/* reserved for future*/

Creates or updates the cell or sub-cell bitmap region by adding a region that is specified by a Windows region handle.

Parameter	Description
nSubCellIndex	A zero-based index into the image list attached to the cell. This sub-cell contains the image that contains the bitmap, which will contain the region handle. Pass -2 to refer to the selected sub-cell. If the cell contains 1 frame then the nSubCellIndex should be 0.
hRgn	Handle to the Windows region.
uCombineMode	The action to take regarding the existing bitmap region, if one is defined. For descriptions of the possible values, refer to Creating a Bitmap Region.
uFlags	Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:
	Value	Meaning
	CELL_APPLYTOTHIS	[0x00000000] Apply the feature to this cell only.
	CELL_APPLYTOALL	[0x10000000] Apply the feature to all the cells in the Image Viewer.
	CELL_APPLYTOSELECTED	[0x20000000] Apply the feature to the selected cells in the Image Viewer.

Returns

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

Comments

This function sets the cell region handle. To get the bitmap region handle, use the LImageViewerCell::GetCellRegionHandle function.

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.

Functions:	LImageViewerCell::GetCellRegionHandle, LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::GetWindowHandle, LImageViewerCell::SetCellBitmapList, LImageViewerCell::SetCellTag, LImageViewerCell::GetCellProperties, LImageViewer::GetCellPosition, LImageViewer::RepositionCell, LImageViewerCell::GetCellBitmapList, LImageViewer::GetCellBounds, LImageViewerCell::FreezeCell, LImageViewerCell::SelectCell, LImageViewerCell::IsCellSelected, LImageViewerCell::IsCellFrozen, Class Members
Topics:	Image Viewer Cells
	Window Control/Image Viewer Functions: Image Viewer Cells