errorcode — An error code
errorcode ::=
(text | phrase
db._phrase | replaceable
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
An error code. Error codes are often numeric, but in some environments they may be symbolic constants.
DocBook provides four elements for identifying the parts of an
error message: errorcode
, for the alphanumeric error
code (e.g., “–2”); errorname
, for the
symbolic name of the error (e.g., “ENOENT”);
errortext
, for the text of the error message (e.g.,
“file not found”); and errortype
, for
the error type (e.g., “recoverable”).
<article xmlns='http://docbook.org/ns/docbook'> <title>Example errorcode</title> <para>On most DOS-derived systems, functions signal a <errortext>File Not Found</errortext> error by returning <errorcode>2</errorcode> (<errorname>ENOENT</errorname>). This is usually a <errortype>recoverable</errortype> (nonfatal) error. </para> </article>
<article xmlns='http://docbook.org/ns/docbook'> <title>Example errorcode</title> <para>On most UNIX systems, functions signal a <errorname>File Not Found</errorname> error by returning <errorcode>ENOENT</errorcode>, defined in <filename>errno.h</filename>. This is usually a <errortype>recoverable</errortype> (nonfatal) error. </para> </article>