Guardian Procedure Calls Reference Manual

TAKE^BREAK Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameter
Returned Value
Considerations
Example
Related Programming Manual
Summary
The TAKE^BREAK procedure enables BREAK monitoring for a file.
The TAKE^BREAK procedure is a sequential I/O (SIO) procedure and should be used only with
files that have been opened by OPEN^FILE.
Syntax for C Programmers
#include <cextdecs(TAKE_BREAK)>
short TAKE_BREAK ( short _near *file-fcb );
Syntax for TAL Programmers
error := TAKE^BREAK ( file-fcb ); ! i
Parameter
file-fcb
input
INT:ref:*
identifies the file for which BREAK is enabled. If the file is not a terminal, or if BREAK is already
owned for this file, the call is ignored.
Returned Value
INT
A file-system or sequential I/O (SIO) procedure error code that indicates the outcome of the call.
Considerations
• BREAK ownership and one terminal
Although the operating system allows a process to own BREAK on an arbitrary number of
terminals, SIO supports BREAK ownership for only one terminal at a time.
• SIO does not support "break access"; SIO always issues SETMODE function 11 with parameter
2 = 0.
• Taking BREAK ownership back
If a process launches an offspring process that takes BREAK ownership, and the parent process
then calls CHECK^BREAK, SIO takes BREAK ownership back. This can affect anticipated
handling of BREAK.
1416 Guardian Procedure Calls (T-V)