Test for Cancellation Detection

This Subprogram tests whether Cancellation (Ctrl-C) has been detected.

This Feature only implemented
for VAX/VMS Systems in Text Mode

Short Name Calling Sequence

STATUS = UITSCA(DUMMY)

Long Name Calling Sequence

STATUS = UI_TEST_CANCEL(...)

Input Arguments

DUMMY (Integer) Dummy Function Argument

Output Arguments

None

Function Value

UI__SUCCESS ) No Cancellation or UISUCC ) Cancel not enabled

UI__CANCELLED ) Cancellation detected UICANC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

1. This call will be ignored if Cancellation Detection is not enabled. Function value UI__SUCCESS will be returned in this case.
2. If Cancellation Detection is currently enabled and a Cancellation has been detected (i.e. the Operator has typed Ctrl-C since the last call to UI_ENABLE_CANCEL or UI_TEST_CANCEL) then Function value UI__CANCELLED will be returned.
3. This Subprogram resets the internal Cancellation Detected Flag. Thus a second call to this Subprogram following the detection of cancellation will not detect another cancellation unless the Operator has typed Ctrl-C in the time interval between the calls.