Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (C)

Guardian Procedure Calls Reference Manual—522629-013

3-14

CHECK^BREAK Procedure

Summary

Syntax for C Programmers

Sytax for TAL Programmers

Parameters

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

Sytax for TAL Programmers

Parameters

state returned value

INT

returns a value indicating whether or not the BREAK key has been typed. Values

are:

1 BREAK key typed; the process owns BREAK.

0 BREAK key not typed; this process does not own BREAK.

common-fcb input

INT:ref:*

identifies the file to be checked for BREAK. The

common-Fcb parameter is

allowed for convenience.

#include <cextdecs(CHECK_BREAK)>

short CHECK_BREAK ( short { _near *common-fcb }

{ _near *file-fcb } );

state := CHECK^BREAK ( { common-fcb } ! i

{ file-fcb } ); ! i