In This Topic ▼

LBitmapList::GetPreviousItem

Summary

Gets the previous item of the bitmap list object.

Syntax

#include "ltwrappr.h"

L_INT LBitmapList::GetPreviousItem(pLBitmap)

Parameters

LBitmapBase * pLBitmap

Pointer to an allocated bitmap object that will receive the previous item of a bitmap list.

Returns

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

Comments

This function will retrieve the bitmap list item that precedes the item at the current index, and decrement the current index if successful. If there is no previous item (the current index = the first item in the list) this function fills pLBitmap with the first item.

You can get the current index by calling LBitmapList::GetCurrentIndex.

The bitmap handle that this function gets and attaches to the passed LBitmapBase object is a copy of the bitmap handle stored internally in the list. If you modify the bitmap, you can update the class object's internal bitmap handle to reflect the changes by using the LBitmapList::SetItem function.

You should not free the bitmap. Instead, use LBitmapList::DeleteItems.

You cannot use this function to update a bitmap list while it is being used in an animation playback.

In order to use this function, you must first allocate an LBitmapBase object (or an object derived from LBitmapBase). Pass the address of the LBitmapBase object, and it will be filled with the item from the bitmap list.