next up previous contents
Next: Viewport Inquiry Subprograms Up: User Output Subprograms Previous: End Batch Update

Swap Batch Update Modes

This Subprogram may be used to setup or terminate Viewport Batch Update Mode and to return the mode previously in effect. It is designed to allow an Application to change the mode, perform some operations and then to restore the original mode.

Short Name Calling Sequence

STATUS = UISWBA(NEWMOD[,OLDMOD])

Long Name Calling Sequence

STATUS = UI_SWAP_BATCH(...)

Input Arguments

NEWMOD (Logical) New Batch Mode (see notes)

Output Arguments

OLDMOD (Logical) Old Batch Mode (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

  1. The NEWMOD Argument should be set to one of the following values:-

    UIBATCHDISABLED ) Batch Update Disabled UIBADI )

    UIBATCHENABLED ) Batch Update Enabled UIBAEN )

    Where these parameters are defined in the UIPACK Parameter Include files (see Appendix B).

  2. The OLDMOD Argument is optional and, if present, will be set to the Batch Mode prior to making this call.
  3. This Subprogram only affects subsequent display operations in ViewText, ViewCursor and Graphics Modes of operation.


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