Guardian Procedure Calls Reference Manual

CHECK^BREAK Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
Example
Related Programming Manual
Summary
The CHECK^BREAK procedure tests whether the BREAK key has been typed 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.
Syntax for C Programmers
#include <cextdecs(CHECK_BREAK)>
short CHECK_BREAK ( short { _near *common-fcb}
{ _near *file-fcb } );
Syntax for TAL Programmers
state := CHECK^BREAK ( { common-fcb } ! i
{ file-fcb } ); ! i
Parameters
common-fcb
input
INT:ref:*
identifies the file to be checked for BREAK. The common-fcb parameter is allowed for
convenience.
file-fcb
input
INT:ref:*
identifies the file to be checked for BREAK.
Returned Value
INT
A value that indicates whether or not the BREAK key has been typed:
BREAK key typed; the process owns BREAK.1
BREAK key not typed; this process does not own BREAK.0
120 Guardian Procedure Calls (C)