| 1 | '\" |
|---|
| 2 | '\" Copyright (c) 1993-1994 The Regents of the University of California. |
|---|
| 3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
|---|
| 4 | '\" |
|---|
| 5 | '\" See the file "license.terms" for information on usage and redistribution |
|---|
| 6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
|---|
| 7 | '\" |
|---|
| 8 | '\" RCS: @(#) $Id: break.n,v 1.10 2007/12/13 15:22:32 dgp Exp $ |
|---|
| 9 | '\" |
|---|
| 10 | .so man.macros |
|---|
| 11 | .TH break n "" Tcl "Tcl Built-In Commands" |
|---|
| 12 | .BS |
|---|
| 13 | '\" Note: do not modify the .SH NAME line immediately below! |
|---|
| 14 | .SH NAME |
|---|
| 15 | break \- Abort looping command |
|---|
| 16 | .SH SYNOPSIS |
|---|
| 17 | \fBbreak\fR |
|---|
| 18 | .BE |
|---|
| 19 | |
|---|
| 20 | .SH DESCRIPTION |
|---|
| 21 | .PP |
|---|
| 22 | This command is typically invoked inside the body of a looping command |
|---|
| 23 | such as \fBfor\fR or \fBforeach\fR or \fBwhile\fR. |
|---|
| 24 | It returns a \fBTCL_BREAK\fR code, which causes a break exception |
|---|
| 25 | to occur. |
|---|
| 26 | The exception causes the current script to be aborted |
|---|
| 27 | out to the innermost containing loop command, which then |
|---|
| 28 | aborts its execution and returns normally. |
|---|
| 29 | Break exceptions are also handled in a few other situations, such |
|---|
| 30 | as the \fBcatch\fR command, Tk event bindings, and the outermost |
|---|
| 31 | scripts of procedure bodies. |
|---|
| 32 | .SH EXAMPLE |
|---|
| 33 | Print a line for each of the integers from 0 to 5: |
|---|
| 34 | .CS |
|---|
| 35 | for {set x 0} {$x<10} {incr x} { |
|---|
| 36 | if {$x > 5} { |
|---|
| 37 | \fBbreak\fR |
|---|
| 38 | } |
|---|
| 39 | puts "x is $x" |
|---|
| 40 | } |
|---|
| 41 | .CE |
|---|
| 42 | |
|---|
| 43 | .SH "SEE ALSO" |
|---|
| 44 | catch(n), continue(n), for(n), foreach(n), return(n), while(n) |
|---|
| 45 | |
|---|
| 46 | .SH KEYWORDS |
|---|
| 47 | abort, break, loop |
|---|
