LBitmapList::SetItem

#include "ltwrappr.h"

virtual L_INT LBitmapList::SetItem(uIndex, pLBitmap, bReflectIndex=TRUE, puSetIndex=NULL)

L_UINT uIndex;

position of the bitmap in the list

LBitmapBase * pLBitmap;

pointer to an LBitmapBase object

L_BOOL bReflectIndex;

flag that indicates whether to set the class object's current index to the passed index

L_UINT * puSetIndex;

pointer to a variable to be updated

Overwrites the internal bitmap handle of a bitmap in a list. Use this function with LBitmapList::GetItem to manipulate a bitmap in a list.

Parameter Description
uIndex Position of the bitmap in the list. Use zero-based indexing. For example, if there are 10 bitmaps in a list, the index of the last one is 9.
pLBitmap Pointer to the bitmap object that will overwrite the internal bitmap handle in the list.
bReflectIndex Flag that indicates whether to set the class object's current index to the passed index. Possible values are:
  Value Meaning
  TRUE Set the class object's current index to the passed index.
  FALSE Do not set the class object's current index to the passed index.
puSetIndex Optional pointer to a variable to be updated with the index where the bitmap is set.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

When a bitmap is in a list, you do not have direct access to the bitmap handle. Therefore, to do any image processing, you must first use LBitmapList::GetItem to get a copy of the internal handle, then do the image processing, then update the internal handle using LBitmapList::SetItem.

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

You cannot set a bitmap that belongs to another bitmap list. Also, if the bitmap to be set is an item of the LBitmapList object, then it will be set at the same index specified when getting the bitmap.

The passed bitmap object will be invalidated after this operation.

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.

Platforms

Win32, x64.

See Also

Functions:

Class Members

Topics:

Raster Image Functions: Playing Animated Images

 

Implementing Animation

Example

For an example, refer to LBitmapList::GetItem.

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

LEADTOOLS Raster Imaging C++ Class Library Help