Setup new Input Mode

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

Short Name Calling Sequence

STATUS = UIINMD(IPMODE[,OLDMOD,CANCEL])

Long Name Calling Sequence

STATUS = UI_INPUT_MODE(...)

Input Arguments

IPMODE (Integer) Input Mode (See Notes) CANCEL (Logical) Cancel Input Flag (Optional)

Output Arguments

OLDMOD (Integer) Old 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 Input Mode prior to this call.
3. The CANCEL Argument is Optional and determines whether an outstanding asynchronous input request is cancelled or converted to a synchronous request when changing from asynchronous to synchronous input mode. If this argument is absent or set .FALSE. an outstanding asynchronous input request will be converted into a synchronous request. If the argument is set .TRUE. an outstanding asynchronous input request will be cancelled.
4. This subprogram by default only affects the Input Mode for the Menu Useage Subprograms and Command Line Input Subprogram (UI_GET_VERB). It does not affect the Prompted Input Subprograms (UI_GET_xxxx) which remain synchronous. However, if UI_GET_MODE has been called prior to this call, indicating that the Prompted Input Subprograms should also be treated as asynchronous, then full asynchronous mode may be setup.
5. This subprogram does not itself issue an asynchronous input request, but rather modifies UIPACK such that the next input request (via a call to the Menu Useage subprograms or Command Line Input subprogram) will act asynchronously if no input already exists within the typeahead buffer. See Appendix D for an example of using Asynchronous Input.