docsrc/xlisp/xlisp-doc/reference/break.htm


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

<html><head><title>XLISP break</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>break</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>xlbfun.c, xldbug.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<p><div class="box">

<dl>
<dt>(<b>break</b> [<i>err-msg</i> [<i>arg</i>]])</dt>
<dd><i>err-msg</i> - a string expression for the error message<br>
<i>arg</i> - an optional argument expression<br>
returns - <a href="nil.htm">NIL</a> when continued from the
break loop</dd>
</dl>

</div></p>

<h2>Description</h2>

<p>The 'break' function allows the entry into the
<nobr><a href="../manual/xlisp.htm#break-loop">Break Loop</a></nobr> with a
continuable error. The continuable error generated by 'break' does not
require any corrective action. The form of the message generated is:</p>

<pre class="example">
break: <font color="#0000CC">err-msg</font> - <font color="#0000CC">arg</font>
if continued: return from BREAK
</pre>

<p> The default for 'err-msg' is:</p>

<pre class="example">
**BREAK**
</pre>

<p>From within the
<nobr><a href="../manual/xlisp.htm#break-loop">Break Loop</a></nobr>, if a
<a href="continue.htm">continue</a> form is evaluated then
<a href="nil.htm">NIL</a> is returned from 'break'. <nobr>If desired</nobr>,
the <a href="clean-up.htm">clean-up</a> or
<a href="top-level.htm">top-level</a> functions may be evaluated to abort
the <nobr><a href="../manual/xlisp.htm#break-loop">Break Loop</a></nobr>.</p>

<h2>Examples</h2>

<pre class="example">
&gt; (break)
break: **BREAK**
if continued: return from BREAK

&gt; (break "out")
break: out
if continued: return from BREAK

&gt; (break "it" "up")
break: it - "up"
if continued: return from BREAK
</pre>

<p>See also:</p>

<ul>
<li><nobr>Contents &rarr; <a href="../manual/contents.htm#debugging-and-error-handling">Debugging and Error Handling</a></nobr></li>
<li><nobr>XLISP 2.0 Manual &rarr; <a href="../manual/xlisp.htm#break-loop">Break Loop</a></nobr></li>
</ul>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>