Use a Viewport

This Subprogram may be used to define which already existing Viewport is to be used for subsequent Output Requests.

Short Name Calling Sequence

STATUS = UIUSVP(VPRTID[,OLDVPT])

Long Name Calling Sequence

STATUS = UI_USE_VIEWPORT(...)

Input Arguments

VPRTID (Integer) Viewport ID

Output Arguments

OLDVPT (Integer) Old Viewport ID (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport ID UIILVP )

Note:

1. Function Value UI__ILLEGAL_VIEWPORT will result if the VPRTID Argument does not refer to an already existing Viewport having the currently setup Viewport Mode (Text or Graphics) defined.
2. Whether the Text or Graphics Viewport corresponding to the specified Viewport ID is used depends on the currently setup Viewport Mode.
3. 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.
4. For a Text Viewport to be made visible it must be displayed via a call to UI_DISPLAY_VIEWPORT.
5. For a Graphics Viewport this Subprogram will setup both the Viewport placement on the Screen and the World Coordinate System as specified at the time of the UI_DEFINE_VIEWPORT request.
6. The OLDVPT Argument is optional an, if present, will be set to the Viewport ID of the Viewport in use prior to this call.
7. The Viewport IDs for the Default Viewports created by UIPACK are defined within the Parameter Definition File described in Appexdix A.3. They are:-

   UIMENUVIEWPORT ) Menu Viewport UIMENU )

   UITITLEVIEWPORT ) Title Viewport UITITL )

   UIINPUTVIEWPORT ) Input Viewport UIINPT )

   UIMAINVIEWPORT ) Main (Help) Viewport UIMAIN )

   UIHELPVIEWPORT ) Help (Main) Viewport UIHELP )