next up previous contents
Next: Inquire Viewport Cursor Up: Viewport Inquiry Subprograms Previous: Inquire Scroll Viewport

Inquire Current Viewport

This Subroutine returns the Viewport ID of the currently setup Viewport. It optionally may be used to return the currently setup Viewport Mode (Text or Graphics).

Short Name Calling Sequence

STATUS = UIIQVP(VPRTID[,VPMODE])

Long Name Calling Sequence

STATUS = UI_INQUIRE_VIEWPORT(...)

Input Arguments

None

Output Arguments

VPRTID (Integer) Viewport ID VPTYPE (Integer) Viewport Mode (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

  1. The Viewport Mode Argument VPMODE is optional and, if present, will be set to the presently setup Viewport Mode (UI_VIEWTEXT_MODE or UI_GRAPHICS_MODE).


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