Define Viewport for Menu Display

This Subroutine defines a new Viewport within which the currently setup Menu will be displayed. The default is for Menus to be displayed in the MENU Viewport (UI_MENU_VIEWPORT), but this may be overridden by this call.

Short Name Calling Sequence

STATUS = UIVPME([VPRTID])

Long Name Calling Sequence

STATUS = UI_VIEWPORT_MENU(....)

Input Arguments

VPRTID (Integer) Viewport ID (Optional)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_MENU ) Illegal Menu UIILME )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport UIILVP )

Note:

1. The VPRTID Argument should correspond to a valid Viewport that has already been defined via UI_DEFINE_VIEWPORT.
2. The VPRTID Argument is optional, and, if omitted, will result in the default MENU Viewport being used for subsequent displays of the currently setup Menu.
3. The currently setup Menu must have been setup via a prior call to UI_DEFINE_MENU or UI_USE_MENU.
4. This Subprogram will only affect the Menu Display for Viewport Modes of operation. It has no effect if UIPACK is in Scroll or Prompted Modes.