LBitmapList::GetCurrentIndex

#include "ltwrappr.h"

L_UINT LBitmapList::GetCurrentIndex()

Gets the current index for the bitmap list object.

Returns

The current index for the bitmap list object.

Comments

The current index controls which item is returned when calling LBitmapList::GetNextItem and LBitmapList::GetPreviousItem.

Use zero-based indexing. For example, if there are 10 bitmaps in a list, the index of the last one is 9.

Note: If the list is empty, this function will return 0.

Required DLLs and Libraries

LTFIL

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:

Class Members

Topics:

Raster Image Functions: Creating and Maintaining Lists of Images

 

Implementing Animation

Example

L_INT LBitmapList__GetCurrentIndexExample(HWND hWnd)
{
   L_INT nRet;
   LBitmapList BitmapList;
   LBitmapBase Bitmap;
   L_TCHAR szDummyBuffer[50];
   L_UINT uCurrentIndex;
   nRet =BitmapList.Create ();
   if(nRet !=SUCCESS)
      return nRet;
   // load three images and insert them in the list
   nRet =Bitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\image1.cmp"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =BitmapList.InsertItem (&Bitmap);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =Bitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\image2.cmp"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =BitmapList.InsertItem (&Bitmap);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =Bitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\image3.cmp"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =BitmapList.InsertItem (&Bitmap);
   if(nRet !=SUCCESS)
      return nRet;
   // Set list to second item
   nRet =BitmapList.SetCurrentIndex(2);
   if(nRet !=SUCCESS)
      return nRet;
   // get the current index
   uCurrentIndex = BitmapList.GetCurrentIndex ();
   wsprintf(szDummyBuffer, TEXT("This is item number %d in list."), uCurrentIndex);
   MessageBox(hWnd, szDummyBuffer, TEXT("LBitmapList"), MB_OK);
   // destroy bitmaplist
   BitmapList.Destroy ();
   
   return SUCCESS;
}