#include "ltwrappr.h"

virtual L_INT LBitmapList::InsertItem(pLBitmap, uIndex=(L_UINT)-1)

Inserts the specified LBitmapBase object's associated bitmap into the class object's bitmap list, or appends the bitmap to the end of the bitmap list.


LBitmapBase * pLBitmap

Pointer to the bitmap object to insert.

L_UINT uIndex

Position of the bitmap in the list. 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.


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


After calling this function, the bitmap handle in the list references the original image data, it is not a copy. Therefore, you should not free the bitmap that you pass in, but should instead manage the memory using the related bitmap list functions (LBitmapList::DeleteItems and LBitmapList::Destroy). This function will invalidate the passed LBitmapBase object before it returns. In order to reuse the LBitmapBase object, you must reinitialize it.

You cannot use this function to update a bitmap list while it is being used in an animation playback. Refer to the LPlayBack::Append function for more information.

Required DLLs and Libraries


Win32, x64.

See Also




For an example, refer to LBitmapList::GetFirstItem.

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

LEADTOOLS Raster Imaging C++ Class Library Help