LImageViewer::GetCellBitmapList

#include "ltwrappr.h"

L_INT LImageViewer::GetCellBitmapList (nCellIndex, phBitmapList, uFlags);

L_INT nCellIndex;	/* index of the cell */
pHBITMAPLIST phBitmapList;	/* pointer to a variable to be updated */
L_UINT uFlags;	/* reserved for future use */

Gets the bitmap list attached to the specified cell.

Parameter	Description
nCellIndex	A zero-based index of the cell for which to get the bitmap list.
phBitmapList	Pointer to the variable to be updated with the cell's bitmap list.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

If the cell at the specified index has no image, phBitmapList will be NULL.

Call the LImageViewer::SetCellBitmapList function to set the bitmap list for a cell.

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, LImageViewer::SetCellBitmapList, LImageViewer::SetCellTag, LImageViewer::SetCellProperties, LImageViewer::GetCellProperties, LImageViewer::RepositionCell, LImageViewer::GetCellPosition, 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

This function removes the specified cell without removing its image list.

L_INT LImageViewer_GetCellBitmapListExample(LImageViewer& ImageViewer) 
{
   HBITMAPLIST hBitmapList; 
   L_INT       nCellIndex = 0 ; 
   L_INT       nRet = 0 ; 
   L_INT       nCount = ImageViewer.GetCellCount(0); 
   // Check the validity of the cell index
   if ((nCellIndex < 0) || (nCellIndex >= nCount)) 
      return FAILURE;
   // retrieve the bitmap list. 
   nRet = ImageViewer.GetCellBitmapList(nCellIndex, &hBitmapList, 0); 
   if(nRet != SUCCESS)
      return nRet;
   // remove the cell
   nRet = ImageViewer.RemoveCell(nCellIndex, FALSE, 0); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}
L_INT LImageViewer_ImageProcessingExample(LImageViewer& ImageViewer, L_INT nCellIndex) 
{
   HBITMAPLIST  hBitmapList;
   L_INT        nRet = 0 ;
   L_INT        nCount = ImageViewer.GetCellCount(0);
   LBitmapList  BitmapList;
   LBitmap      MyBitmap;
   // Check the validity of the cell index
   if ((nCellIndex < 0) || (nCellIndex >= nCount))
      return FAILURE;
   // retrieve the bitmap list. 
   nRet = ImageViewer.GetCellBitmapList(nCellIndex, &hBitmapList, 0);
   if(nRet != SUCCESS)
      return nRet;
   nRet = ImageViewer.SetCellBitmapList(nCellIndex, NULL, 0, 0);
   if(nRet != SUCCESS)
      return nRet;
   BitmapList.SetHandle(hBitmapList);
   nRet = BitmapList.GetItem(0, &MyBitmap, sizeof(BITMAPHANDLE));
   if(nRet != SUCCESS)
      return nRet;
   nRet = MyBitmap.Invert();
   if (nRet != SUCCESS)
      return nRet;
   nRet = BitmapList.SetItem(0, &MyBitmap);
   if(nRet != SUCCESS)
      return nRet;
   hBitmapList = BitmapList.GetHandle();
   nRet = ImageViewer.SetCellBitmapList(nCellIndex, hBitmapList, 0, 0);
   BitmapList.SetHandle(NULL, 0, FALSE);
   return nRet;
}