next up previous contents
Next: Inquire current Viewport Up: Viewport Inquiry Subprograms Previous: Inquire Viewport Dimensions

Inquire whether Viewport exists

This Subroutine may be used to indicate whether the specified Viewport ID exists in either or both of the Text and Graphics Modes.

Short Name Calling Sequence

STATUS = UIIQVX(VPRTID,TEXIST,GEXIST)

Long Name Calling Sequence

STATUS = UI_INQUIRE_VIEWPORT_EXISTS(...)

Input Arguments

VPRTID (Integer) Viewport ID

Output Arguments

TEXIST (Logical) Text Viewport Flag GEXIST (Logical) Graphics Viewport Flag

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport UIILVP )

Note:

  1. The TEXIST Argument will be set to .TRUE. if the specified Viewport exists in Text Mode.
  2. The GEXIST Argument will be set to .TRUE. if the specified Viewport exists in Graphics Mode.
  3. If TEXIST and GEXIST are both .FALSE. but Function Value UI__SUCCESS is returned, this indicates that the specified Viewport has been assigned but not yet defined.
  4. Function Value UI__ILLEGAL_VIEWPORT indicates that the specified Viewport does not exist in either Text or Graphics Mode, nor has it been assigned. This is an informational error code, no error message will be produced.


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