Inquire Viewport Batch Update Mode

This Subprogram allows the current Viewport Batch Update Mode to be determined. When Batch Update is enabled, intermediate activity to the screen is delayed, thus allowing only the resultant screen image to be presented to the User when Batch Update Mode is terminated.

Short Name Calling Sequence

STATUS = UIIQBU(MODE)

Long Name Calling Sequence

STATUS = UI_INQUIRE_BATCH_UPDATE(...)

Input Arguments

None

Output Arguments

MODE (Logical) Batch Update Mode

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

1. The MODE Output Argument can take 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 Batch Update Mode Argument MODE will be set to UI_BATCH_DISABLED if UIPACK has not been initialised.