Define Viewport for Help File Display

This Subroutine defines a new Viewport within which Help information for Verbs in the current Verb Group should be displayed. The default is for Help information to be displayed in the HELP Viewport (UI_HELP_VIEWPORT), but this may be overridden by this call.

Short Name Calling Sequence

STATUS = UIVPHE([VPRTID])

Long Name Calling Sequence

STATUS = UI_VIEWPORT_HELP(....)

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_GROUP ) Illegal Verb Group UIILGP )

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 HELP Viewport being used for subsequent displays of Help information for Verbs within the current Group.
3. The currently setup Verb Group must have been setup via a prior call to UI_DEFINE_GROUP or UI_USE_GROUP.
4. This Subprogram will only affect the Help Display for Viewport Modes of operation. It has no effect if UIPACK is in Scroll or Prompted Modes.