Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$ADD^XPDMENU(): Add Option to Menu

Reference Type: Supported, Category: Menu Manager, ICR#: 1157

Description

The $$ADD^XPDMENU extrinsic function adds an option as a new item to an existing menu.

Format

  $$ADD^XPDMENU(menu,option[,syn][,order])

Input Parameters

menu:

(required) Name of the menu to which an option should be added.
option:

(required) Name of the option being added to the menu.
syn:

(optional) Synonym to add to the SYNONYM field in the new menu item.
order:

(optional) Order to place in the DISPLAY ORDER field in the new menu item.

Output

returns:

Returns:

  • 1—Success, option added to menu.

  • 0—Failure, option not added to menu.