Setup new Get Input Mode

This Subprogram allows a Programmer to specify a new Input (Synchronous or Asynchronous) Mode for the Prompted Input (GET) Subprograms within the Package.

Short Name Calling Sequence

STATUS = UIGTMD(IPMODE[,OLDMOD])

Long Name Calling Sequence

STATUS = UI_GET_MODE(...)

Input Arguments

IPMODE (Integer) Get Input Mode (See Notes)

Output Arguments

OLDMOD (Integer) Old Get Input Mode (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_MODE ) Illegal Input Mode UIILMD )

Note:

1. IPMODE may be set to one of the following Values (as defined in the Parameter Definition Include File described in Appendix B.3):-

   UIINPUTSYNCHRONOUS ) UIINPUTWAIT ) Synchronous Input Mode UISYNC ) UIWAIT )

   UIINPUTASYNCHRONOUS ) UIINPUTNOWAIT ) Asynchronous Input Mode UIASYN ) UINOWA )

   Any value other than these will give rise to a UI__ILLEGAL_MODE Error and the request will be ignored.

2. The OLDMOD Argument is Optional and, if present, will be set to the Old Get Input Mode prior to this call.
3. UIPACK is setup by default such that the Prompted Input (UI_GET_xxxx) Subprograms are synchronous. This default may be overridden via the use of this Subprogram.
4. Calling this Subprogram does not actually immediately enable asynchronous input mode for the Prompted Input Subprograms. Full Asynchronous Input Mode must also be enabled by calling UI_INPUT_MODE with the appropriate arguments.