Specify Viewport Mode Text or Graphics

This Subprogram specifies the Viewport Mode (Text or Graphics) for subsequent Viewport Operations. Thus this Subprogram determines whether subsequent requests to define a Viewport will create a Text or Graphics Viewport, treating the dimensions as being in Text or Graphics units as appropriate etc.

Short Name Calling Sequence

STATUS = UIVPMD(VPMODE[,OLDMOD])

Long Name Calling Sequence

STATUS = UI_VIEWPORT_MODE(...)

Input Arguments

VPMODE (Integer) Viewport Mode

Output Arguments

OLDMOD (Integer) Old Viewport Mode

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

1. Valid Viewport Modes are:-

   UIPROMPTEDMODE        Prompted Mode
   UIPRMD                  (treated as Text Mode)
   
   UISCROLLMODE          Text Scroll Mode
   UISCMD                  (treated as Text Mode)
   
   UIVIEWTEXTMODE        Viewport/Text Mode
   UIVTMD                  (treated as Text Mode)
   
   UIVIEWCURSORMODE      Viewport/Cursor Mode
   UIVCMD                  (treated as Text Mode)
   
   UIGRAPHICSMODE        Graphics Mode
   UIGRMD                  (treated as Graphics Mode)
   

   where these Parameters are defined in the Parameter Definition Include file described in Appendix B.3.
2. The Viewport Mode defaults to Text on initialisation of UIPACK.
3. The OLDMOD Argument is Optional and, if present, will be set to the Old Viewport Mode prior to this call.