References ▼
Sends the requested images to the control.
#include "ltwrappr.h"
L_INT LImageViewer::SetRequestedImage(nCellIndex, pBitmaps, pBitmapIndexes, nLength, uFlags)
A zero based index of the cell to set the requested image for.
Array of a BITMAPHANDLE structure that contains the requested frames.
Array of integers containing the index of each bitmap in pBitmaps in respective manner.
Length of the pBitmapIndexes array.
Flag that indicate how to handle the images set. Possible values are:
| Value | Meaning |
|---|---|
| CONTAINER_SETIMAGE_INSERT | [0x00000000] Insert the requested image. This is the default value. |
| CONTAINER_SETIMAGE_REPLACE | [0x00000001] Replace the requested image with the corresponding index. |
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
This function is used when the low memory usage feature is enabled. For more information, refer to LImageViewerCell::EnableCellLowMemoryUsage function.
The low memory usage feature works by stopping the control from loading all the frames at runtime. Instead, the control will load only the frames that are currently visible on the cell. The control will send a request each time the user scrolls down or up, changes the number of visible frames, etc. For example, suppose the cell layout is a 2X2 (Refer to LImageViewerCell::SetCellProperties), and the user needs to load more than 100000 frames. The control will not load them all. This function will send a callback (LImageViewerCell::LowMemoryUsageCallBack) when the cell is loaded requesting 4 frames (1, 2, 3 and 4) (because the cell is 2X2). Once the user scrolls down the cell to show frame number 5, frame number 1 will be disposed of because it is no longer visible, and the callback will be fired to request frame number 5. When frames are requested, the user is supposed to send them to the control using the LImageViewerCell::SetRequestedImage function.
For the callback, use the LImageViewerCell::LowMemoryUsageCallBack function, to use this callback, it must first be set by calling LImageViewerCell::EnableLowMemoryUsageCallBack function.