next up previous contents
Next: Specify Viewport Mode Up: Viewport Manipulation Subprograms Previous: Assign Viewport ID

Deassign Drop a Viewport

This Subprogram may be used to deassign (drop) a previously assigned Viewport ID. If the Viewport has any Menus associated with it then they will be redirected to the MENU Viewport for subsequent displays. This request will be treated as illegal if the specified Viewport is Locked.

Short Name Calling Sequence

STATUS = UIDRVP(VPRTID)

Long Name Calling Sequence

STATUS = UI_DROP_VIEWPORT(...)

Input Arguments

VPRTID (Integer) Viewport ID

Output Arguments

None

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. Error UI__LOCKED_VIEWPORT will be returned if the specified Viewport has been locked by a prior call to UI_LOCK_VIEWPORT.
  2. Both the Text and Graphics Viewports associated with this Viewport ID will be dropped if they exist.
  3. If the specified Viewport is the ``current" Viewport (as defined by a prior call to UI_DEFINE_VIEWPORT or UI_USE_VIEWPORT), the current Viewport will be redefined to be the Input Viewport.


Liz Buckle
Fri Jan 13 17:49:20 CST 1995