Guardian Programming Reference Summary for C

Functions Summary (A-C)
Guardian Programming Reference Summary for C522630-001
4-12
function
parameter
CHECK^BREAK
Tests whether the BREAK key has been pressed since the last CHECK^BREAK.
CHECK^BREAK is a sequential I/O (SIO) procedure and can be used only with files
that have been opened by OPEN^FILE.
return value:
>= 0 = Changes the poll state bit.
-1 = Changes the polling type.
-2 = Restores all partially disabled stations.
>= 0 = Set (1) or clear (0) poll or select state bit.
-1 = Continuous polling (0) or noncontinuous polling (>0).
-2 = Dummy value.
#include <cextdecs(CHECK_BREAK)>
short CHECK_BREAK ( short { _near *common-fcb } /* i */
{ _near *file-fcb } );/* i */
1 = The BREAK key was pressed; the process owns BREAK.
0 = The BREAK key was not pressed; this process does not own BREAK.