URL
https://opencores.org/ocsvn/or1k/or1k/trunk
[/] [or1k/] [trunk/] [insight/] [tcl/] [doc/] [break.n] - Blame information for rev 1765
Details |
Compare with Previous |
View Log
| Line No. |
Rev |
Author |
Line |
| 1 |
578 |
markom |
'\"
|
| 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.1.1.1 2002-01-16 10:25:24 markom 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 TCL_BREAK 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 |
|
|
|
| 33 |
|
|
.SH KEYWORDS
|
| 34 |
|
|
abort, break, loop
|
© copyright 1999-2024
OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.