Specify a new Priority for Viewport

This Subprogram specifies a new Priority for the currently setup Viewport and (optionally) returns the previous priority.

Short Name Calling Sequence

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

Long Name Calling Sequence

STATUS = UI_PRIORITY_VIEWPORT(...)

Input Arguments

NEWPRI (Integer) New Priority VPRTID (Integer) Viewport ID (Optional)

Output Arguments

OLDPRI (Integer) Old Priority (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport ID UIILVP )

UI__LOCKED_VIEWPORT ) Viewport Locked UIVLOK )

Note:

1. This subprogram operates on the currently setup Viewport which must have been setup by a prior call to UI_DEFINE_VIEWPORT or UI_USE_VIEWPORT.
2. Error UI__LOCKED_VIEWPORT will be returned, and the request denied, if the currently setup Viewport has been locked by a prior call to UI_LOCK_VIEWPORT.
3. The OLDPRI Argument is optional and, if specified, will be set to the priority of the Viewport prior to this call.
4. A Negative Priority will cause the display of the Viewport to be inhibited (and for it to be removed from the screen if it is already visible).
5. A change in the Priority may cause the screen image to be refreshed to reflect the adjusted priorities.
6. An attempt to disable the Input Viewport (UI_INPUT_VIEWPORT) by making its priority negative is illegal and will give rise to an UI__ILLEGAL_VIEWPORT Error.
7. The VPRTID Argument is optional and, if omitted, defaults to the currently setup Viewport.