Break¶

Status: Stable

documented, exercised by the test suite and/or worked examples, with no known limitations recorded.

Description¶

Break[] exits the nearest enclosing Do, For, or While loop.

Break[] takes effect as soon as it is evaluated.

Notes

After Break\[\], the enclosing loop returns Null. Break has attribute Protected.

Every input below was run against the current Mathilda build and its output recorded.

In[1]:= Do[Print[i]; If[i > 2, Break[]], {i, 10}] 1 2 3
Out[1]= 6 Null

In[2]:= For[i = 1, i <= 10, i++, If[i > 2, Break[]]]; i
Out[2]= 3

Has attribute Protected.
Takes effect as soon as it is evaluated (e.g. inside an If within the body), escaping only the innermost enclosing loop.
Outside any loop, Break[] emits the message Break::nofwd and returns Hold[Break[]] (inert, so feeding it back does not re-trigger).

Attributes: Protected.

See also: Do, For, While, If