Simulate Cancellation Detection

This Subprogram simulates Cancellation detection if it is enabled. The internal Cancellation Detection flag will be set and any User-specified Cancellation Subroutine will be called. A subsequent call to UI_TEST_CANCEL will result in cancellation being detected.

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

Short Name Calling Sequence

STATUS = UISICA(DUMMY)

Long Name Calling Sequence

STATUS = UI_SIMULATE_CANCEL(...)

Input Arguments

DUMMY (Integer) Dummy Function Argument

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC ) (Cancel not enabled)

UI__CANCELLED ) Success UICANC ) (Cancel enabled)

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 a User Cancellation AST Subprogram has previously been defined via a call to UI_DEFINE_CANCEL_AST then it will be called if Cancellation Detection is currently enabled.
3. If Cancellation Detection is currently enabled then Function value UI__CANCELLED will be returned and a subsequent call to UI_TEST_CANCEL will detect a Cancellation.