GetTrayIconMenuItemAttr
int GetTrayIconMenuItemAttr (int iconHandle, int itemIndex, int popupMenuAttribute, int *value);
Purpose
This function gets the value of an attribute of a particular item on the specified System Tray icon's popup menu.
See the Class Help for more information about the recommended usage of System Tray icons and their popup menus.
(Linux) This function is not supported.
Parameters
| Input | ||
| Name | Type | Description |
| iconHandle | int | The handle of the System Tray icon for which you wish to get a popup menu item attribute. This handle will have been returned from InstallSysTrayIcon. |
| itemIndex | int | The index of the item for which you wish to get an attribute. The item index corresponds to its 1–based position on the popup menu, and will have been returned from InsertTrayIconMenuItem. |
| popupMenuAttribute | int | The tray icon menu item attribute value to obtain. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
| Output | ||
| Name | Type | Description |
| value | int | The value of the specified tray icon menu item attribute. If the attribute shown in this control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
Return Value
| Name | Type | Description |
| status | int | The status code that the function returns. 0 indicates success. A negative value indicates an error. This function may return a Programmer's Toolbox or UI Library error code. Call GetGeneralErrorString to obtain a text description of the error. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later