Prompt for Operator Response

This Subprogram will prompt for the Operator to respond by hitting the RETURN key. The specified Prompt will only be issued if the Operator has not anticipated the input request.

Short Name Calling Sequence

         STATUS = UIPAUS(PROMPT)

Long Name Calling Sequence

         STATUS = UI_PAUSE(...)

Input Arguments

         PROMPT (Character)     Prompt Text

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__INPUT_ABORTED ) Input Aborted (Ctrl-Z) UIABRT )

UI__NO_INPUT ) No Input present UINOIN )

UI__END_OF_FILE ) End-of-File detected UIEOF ) in Batch Mode Note:

1. The format of the prompt issued to the Operator depends whether a null (all spaces) Prompt String PROMPT is specified. If this is non-null, it is used directly as the prompt (concatenated with a colon ``:" character as terminator). If the specified Prompt String is null, then a default prompt will be issued.
2. This Subprogram expects the Operator response to be to hit the RETURN key. If any text is typed prior to the RETURN key, the first word will be lost but subsequent words will be treated as type-ahead for later input requests.
3. The UI__INPUT_ABORTED Function Value indicates that the User typed Ctrl-Z to abort input. This is only implemented on a VAX/VMS system. It is an informational function value only, no error message will be reported.
4. UI__NO_INPUT will only be returned in Asynchronous Mode (if both UI_INPUT_MODE and UI_GET_MODE have signified Asynchronous Input Mode) and indicates that the User has not yet specified any Input. The Application Program should poll by either calling this Subprogram repeatedly or by calling UI_TEST_INPUT repeatedly until this indicates that some Input has been received. In the latter case (UI_TEST_INPUT called) this Subprogram should be recalled in order to flush the input. UIPACK is setup by default such that this subprogram always acts synchronously unless a prior call to UI_GET_MODE has been made within the Application Program.
5. The UI__END_OF_FILE Function Value indicates that an End-of-File was detected on the main Input Stream in Batch or non-interactive mode where Input is not taken from a terminal but rather from a file. It is a severe error and therefore causes an error to be reported (unless this has been inhibited by a prior call to UI_ERROR_LEVEL).
6. The Prompt string will only be issued if the response is not already present in the input line.