Get menu item mark
Get menu item mark ( menu ; menuItem {; process} ) : Text
| Parameter | Type | Description | |
|---|---|---|---|
| menu | Integer, Text | → | Menu number or Menu reference |
| menuItem | Integer | → | Menu item number or -1 for last item added |
| process | Integer | → | Process reference number |
| Function result | Text | ← | Current menu item mark |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The Get menu item mark command returns the check mark of the menu item whose number or reference is passed in menu and whose item number is passed in menuItem. You can pass -1 in menuItem in order to indicate the last item added to menu.
If you omit the process parameter, Get menu item mark applies to the menu bar for the current process. Otherwise, Get menu item mark applies to the menu bar for the process whose reference number is passed in process.
Note: If you pass a MenuRef in menu, the process parameter serves no purpose and will be ignored.
If the menu item has no mark or if the menuItem parameter specifies a hierarchical submenu, Get menu item mark returns an empty string.
Note: See discussion of check marks on Macintosh and Windows in the description of the SET MENU ITEM MARK command.
Example
The following example toggles the check mark of a menu item:
SET MENU ITEM MARK($vlMenu;$vlItem;Char(18)*Num(Character code(Get menu item mark($vlMenu;$vlItem))#18))