next up previous contents
Next: Modify Size or Up: Viewport Manipulation Subprograms Previous: Hide a Viewport

Define Viewport for Input Prompting

This Subprogram overrides the default Viewport that is used for Input Promting and echoing of Operator input.

Short Name Calling Sequence

STATUS = UIIPVP([NEWVPT,OLDVPT])

Long Name Calling Sequence

STATUS = UI_INPUT_PROMPT_VIEWPORT(...)

Input Arguments

NEWVPT (Integer) New Viewport ID (Optional)

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. Both Arguments to this Subprogram are optional and may be omitted. If neither Argument is present, the Input Viewport is restored as being used for subsequent Input Prompts and Echoing. If the OLDVPT is present, the Viewport that was in use prior to this call will be returned.
  2. The specified NEWVPT Viewport must have been previously defined via a call to UI_DEFINE_VIEWPORT.


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