GetListItemImage
int GetListItemImage (int panelHandle, int controlID, int itemIndex, int *image);
Purpose
Returns a value corresponding to the image state of a specific list item.
The image state of a list item indicates the presence of various folder icons next to the item.
This function is not valid for picture ring controls. To obtain the image for a picture ring items, use GetImageBits.
Supported Controls
You can use GetListItemImage with list box controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| itemIndex | int | Zero-based index into the list. |
| Output | ||
| Name | Type | Description |
| image | int | The value corresponding to the image state of the list item you specify. The following lists the possible image states. 0 = VAL_NO_IMAGE 1 = VAL_FOLDER 2 = VAL_OPEN_FOLDER 3 = VAL_CURRENT_FOLDER |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later