Make a Viewport the Top one

This Subprogram forces the specified Viewport in the currently setup Viewport Mode to become the topmost Viewport. Thus it will occlude any other Viewports that previously were occluding it.

Short Name Calling Sequence

STATUS = UITPVP(VPRTID[,OLDPRI,NEWPRI])

Long Name Calling Sequence

STATUS = UI_TOP_VIEWPORT(...)

Input Arguments

VPRTID (Integer) Viewport ID

Output Arguments

OLDPRI (Integer) Old Priority (Optional) NEWPRI (Integer) New Priority (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport ID UIILVP

Note:

1. The specified Viewport will have its priority raised to be greater than any other Viewport and will then be displayed. This will cause it to ``top" to the front of the screen.
2. The specified Viewport must have been previously defined via a call to UI_DEFINE_VIEWPORT.
3. Whether the Text or Graphics Viewport corresponding to the specified Viewport ID is redisplayed depends on the currently setup Viewport Mode.
4. The Viewport Mode is defaulted to Text on initialisation of UIPACK. It may be changed by calling UI_VIEWPORT_MODE and may be determined by calling UI_INQUIRE_VIEWPORT_MODE.
5. The OLDPRI Argument is optional and, if present, will be set to the priority of the Viewport prior to this call.
6. The NEWPRI Argument is optional and, if present, will be set to the priority of the Viewport following this call.
7. This Subprogram does not affect the definition of the currently setup Viewport which remains as defined by the last call to UI_DEFINE_VIEWPORT or IU_USE_VIEWPORT.