check_user_menu()

Five user menus are available in each of the three ADS windows: Main, Schematic, and Layout. This function can be used to determine if a user menu is being used by another application. It returns the current label of the specified user menu. If the label has not be reset by a user or application, the default name will be returned. If a different label is returned, the label has been reset, and the menu is probably in use by another application.

This function takes an integer 1-5 and returns the default names of "User", "User2", "User3", "User4", or "User5". These predefined AEL constants may be used instead: deUserMenuName, deUser2MenuName, deUser3MenuName, etc. For a complete example, which uses this function to find the first available user menu, refer to Creating a Custom Menu in the Customization and Configuration manual.

See also: add_menu(), add_separator(), set_user_menu_label(), clear_user_menu().

Syntax:

check_user_menu( menuIndex );

where

menuIndex is an integer 1-5

Example:

fputs(stderr, check_user_menu( 1 ));

Where Used:

Graphical user interface