Inquire Get Input Mode

This Subprogram allows the current Get Input Mode (synchronous or asynchronous) for the Prompted Input Subprograms to be determined.

Short Name Calling Sequence

STATUS = UIIQGI(MODE)

Long Name Calling Sequence

STATUS = UI_INQUIRE_GET_INPUT(...)

Input Arguments

None

Output Arguments

MODE (Integer) Input Mode (See Notes)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

1. The MODE Argument may take on two values:-

   UIINPUTSYNCHRONOUS ) UIINPUTWAIT ) Synchronous Input Mode UISYNC ) UIWAIT )

   UIINPUTASYNCHRONOUS ) UIINPUTNOWAIT ) Asynchronous Input Mode UIASYN ) UINOWA )

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

2. The Get Input Mode differs from the Input Mode in that it controls whether the Prompted Input Subprograms (UI_GET_xxxx) are always treated synchronously, independent of the Input Mode, or will be treated asynchronously when the Input Mode is asynchronous. The default is for these Subprograms to always be treated synchronously.
3. The Get Input Mode Argument MODE will be set to UI_INPUT_SYNCHRONOUS if UIPACK has not been initialised.