GetLabelFromIndex
int GetLabelFromIndex (int panelHandle, int controlID, int itemIndex, char itemLabel[]);
Purpose
Returns the label of a specific list item.
For picture ring controls, this function returns an empty string.
Supported Controls
You can use GetLabelFromIndex with the following 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 |
| itemLabel | char [] | Buffer into which the label of the selected list item is stored. The number of bytes in this buffer must be at least one byte greater than the value returned by GetLabelLengthFromIndex for this list item. |
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
Examples
Refer to the following examples that use the GetLabelFromIndex function:
- userint\graphlegend.cws
Open example - userint\listbox.cws
Open example - userint\treeevent.cws
Open example