Erase a Viewport

This Subprogram erases the specified Viewport in the currently setup Viewport Mode (Text or Graphics).

Short Name Calling Sequence

STATUS = UIERVP([VPRTID])

Long Name Calling Sequence

STATUS = UI_ERASE_VIEWPORT(...)

Input Arguments

VPRTID (Integer) Viewport ID (Optional)

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 VPRTID Argument is optional and, if omitted, the currently setup Viewport will be erased. The parentheses denoting a Function Call must still be specified in this instance.
2. Only the Viewport corresponding to the currently setup Viewport Mode will be erased.
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. For a Text Viewport to be made visible it must be displayed via a call to UI_DISPLAY_VIEWPORT. This may be performed either prior to, or following, this call.