L_InsertBitmapListItem

#include "l_bitmap.h"

L_LTKRN_API L_INT L_InsertBitmapListItem(hList, uIndex, pBitmap)

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

Parameters

HBITMAPLIST hList

Handle to the list of bitmaps.

L_UINT 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.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle to insert.

Returns

Value Meaning
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

Platforms

Win32, x64, Linux.

Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help