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.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
itemIndex integer Zero-based index into the list.
Output
Name Type Description
itemLabel string 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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success