DiscardCtrlMenuItem
int DiscardCtrlMenuItem (int panelHandle, int controlID, int menuItemID);
Purpose
Removes a menu item from the menu owned by the specified control.
You cannot remove a built-in menu item. To hide a built-in menu item, use the HideBuiltInCtrlMenuItem function. To delete all user-defined menu items, pass –1 for menuItemID.
Supported Controls
You can use DiscardCtrlMenuItem 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. |
| menuItemID | int | The ID used to reference this menu item. Use a menuItemID you obtained from NewCtrlMenuItem or NewCtrlMenuSeparator. To delete all user-defined menu items, pass –1. |
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 5.5 and later
Example
Refer to userint\treemenu.cws for an example of using the DiscardCtrlMenuItem function.