Hide a Viewport

This Subprogram hides (removes from the Display) the specified Viewport.

Short Name Calling Sequence

STATUS = UIHIVP(VPRTID)

Long Name Calling Sequence

STATUS = UI_HIDE_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 )

Note:

1. The specified Viewport must have been previously defined via a call to UI_DEFINE_VIEWPORT.
2. Whether the Text or Graphics Viewport corresponding to the specified Viewport ID is hidden depends on the currently setup Viewport Mode.
3. 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.
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. An attempt to hide the Input Viewport (UI_INPUT_VIEWPORT) is illegal and will give rise to an UI__ILLEGAL_VIEWPORT Error.