LImageViewer::GetCellRegionHandle

#include "ltwrappr.h"

L_INT LImageViewer::GetCellRegionHandle(nCellIndex, nSubCellIndex, phRgn, uFlags)

L_INT nCellIndex;	/* index of the cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
L_HRGN * phRgn;	/* address of the variable to be updated */
L_UINT uFlags;	/* reserved for future */

Retrieves a copy of the region handle for the specified bitmap in the specified cell.

Parameter	Description
nCellIndex	A zero-based index of the cell for which to retrieves the region handle from. Pass -2 to retrieve the region of the first selected cell.
nSubCellIndex	A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell contains the image that contains the bitmap region that needs to be retrieved. Pass -2 to refer to the selected sub-cell.
phRgn	Pointer to the Windows region handle. You do not have to create the region. You just declare the HRGN variable and pass its address.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

You should delete the region handle once it is no longer needed using the windows function DeleteObject.

This function gets the cell region handle. To set the bitmap region handle, use the LImageViewer::SetCellRegionHandle 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.

See Also

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

Example