L_InsertBitmapListItem

Show in webframe

#include "l_bitmap.h"

L_LTKRN_API L_INT L_InsertBitmapListItem(hList, uIndex, pBitmap)

HBITMAPLIST hList;	/* handle to the list of bitmaps */
L_UINT uIndex;	/* position at which to insert the bitmap */
pBITMAPHANDLE pBitmap;	/* pointer to the bitmap handle */

Inserts a bitmap handle into a list, or appends the bitmap handle to the end of the list.

Parameter	Description
hList	Handle to the list of bitmaps.
uIndex	Position in the list at which to insert the bitmap. Use (L_UINT)-1 to append the bitmap to the end of the list.
	Use zero-based indexing. For example, if there are 10 bitmaps in a list, the index of the last one is 9. If you insert a bitmap within a list, the indexes of other bitmaps change to accommodate the insertion.
pBitmap	Pointer to the bitmap handle to insert.

Returns

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

Comments

After calling this function, the bitmap handle in the list references the original image data, not a copy. Therefore, you should not free the bitmap that you pass in, but should instead manage the memory using the related list functions (L_DeleteBitmapListItems and L_DestroyBitmapList).

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

Required DLLs and Libraries

LTKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Linux.

See Also

Functions:	L_LoadBitmapList, L_SaveBitmapList, L_CreateBitmapList, L_DestroyBitmapList, L_CopyBitmapListItems, L_GetBitmapListCount, L_RemoveBitmapListItem, L_DeleteBitmapListItems, L_GetBitmapListItem, L_SetBitmapListItem, L_ColorResBitmapList, L_TranslateBitmapColor
Topics:	Raster Image Functions: Playing Animated Images
	Implementing Animation

Example

For an example, refer to L_CreateBitmapList.