blob: 81640af61c7cb62fe078a41d59da7badf002ac1c [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>@error (GNU Texinfo 6.8dev)</title>
<meta name="description" content="@error (GNU Texinfo 6.8dev)">
<meta name="keywords" content="@error (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Glyphs-for-Programming.html" rel="up" title="Glyphs for Programming">
<link href="_0040equiv.html" rel="next" title="@equiv">
<link href="_0040print.html" rel="prev" title="@print">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="g_t_0040error">
<div class="nav-panel">
<p>
Next: <a href="_0040equiv.html" accesskey="n" rel="next"><code class="code">@equiv{}</code> (&equiv;): Indicating Equivalence</a>, Previous: <a href="_0040print.html" accesskey="p" rel="prev"><code class="code">@print{}</code> (-|): Indicating Generated Output</a>, Up: <a href="Glyphs-for-Programming.html" accesskey="u" rel="up">Glyphs for Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="g_t_0040error_007b_007d-_0028error_002d_002d_003e_0029_003a-Indicating-an-Error-Message">11.9.5 <code class="code">@error{}</code> (error&rarr;): Indicating an Error Message</h4>
<a class="anchor" id="Error-Glyph"></a><a class="index-entry-id" id="index-Error-message_002c-indicating"></a>
<a class="index-entry-id" id="index-error"></a>
<p>A piece of code may cause an error when you evaluate it. You can
designate the error message with the <code class="code">@error{}</code> command.
</p>
<p>The <code class="code">@error{}</code> command is displayed as &lsquo;<samp class="samp">error&rarr;</samp>&rsquo;, either
the word &lsquo;error&rsquo; in a box in the printed output, the word error
followed by an arrow in other formats or (when no arrow is available)
&lsquo;<samp class="samp">error--&gt;</samp>&rsquo;.
</p>
<p>Thus,
</p>
<div class="example">
<pre class="example-preformatted">@lisp
(+ 23 'x)
@error{} Wrong type argument: integer-or-marker-p, x
@end lisp
</pre></div>
<p>produces
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(+ 23 'x)
error&rarr; Wrong type argument: integer-or-marker-p, x
</pre></div>
<p>This indicates that the following error message is printed
when you evaluate the expression:
</p>
<div class="example lisp">
<pre class="lisp-preformatted">Wrong type argument: integer-or-marker-p, x
</pre></div>
<p>The word &lsquo;<samp class="samp">error&rarr;</samp>&rsquo; itself is not part of the error message.
</p>
</div>
</body>
</html>