1996-06-26 06:06:43 +00:00
|
|
|
'\"
|
|
|
|
|
'\" Copyright (c) 1993-1994 The Regents of the University of California.
|
|
|
|
|
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
|
|
|
|
|
'\"
|
|
|
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
|
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
|
|
|
'\"
|
1997-07-25 19:27:55 +00:00
|
|
|
'\" SCCS: @(#) break.n 1.7 96/10/09 08:29:26
|
1996-06-26 06:06:43 +00:00
|
|
|
'\"
|
|
|
|
|
.so man.macros
|
|
|
|
|
.TH break n "" Tcl "Tcl Built-In Commands"
|
|
|
|
|
.BS
|
|
|
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
|
|
|
.SH NAME
|
|
|
|
|
break \- Abort looping command
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
\fBbreak\fR
|
|
|
|
|
.BE
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.PP
|
|
|
|
|
This command is typically invoked inside the body of a looping command
|
|
|
|
|
such as \fBfor\fR or \fBforeach\fR or \fBwhile\fR.
|
|
|
|
|
It returns a TCL_BREAK code, which causes a break exception
|
|
|
|
|
to occur.
|
|
|
|
|
The exception causes the current script to be aborted
|
1997-07-25 19:27:55 +00:00
|
|
|
out to the innermost containing loop command, which then
|
1996-06-26 06:06:43 +00:00
|
|
|
aborts its execution and returns normally.
|
|
|
|
|
Break exceptions are also handled in a few other situations, such
|
|
|
|
|
as the \fBcatch\fR command, Tk event bindings, and the outermost
|
|
|
|
|
scripts of procedure bodies.
|
|
|
|
|
|
|
|
|
|
.SH KEYWORDS
|
|
|
|
|
abort, break, loop
|
