errorcode — An error code
errorcode ::=
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)remark
replaceable
subscript
superscript
xref
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”).
These elements contain errorcode
: bridgehead
, citation
, citetitle
, classsynopsisinfo
, emphasis
(db.emphasis), entry
, firstterm
, funcsynopsisinfo
, glosssee
, glossseealso
, glossterm
, html:button
, html:label
, html:legend
, link
, literallayout
, member
, olink
, orgdiv
, para
, phrase
(db.phrase), primary
, primaryie
, programlisting
, quote
, refdescriptor
, refentrytitle
, refname
, refpurpose
, screen
, secondary
, secondaryie
, see
, seealso
, seealsoie
, seeie
, seg
, segtitle
, simpara
, subtitle
, synopsis
, td
, term
, termdef
, tertiary
, tertiaryie
, th
, title
, titleabbrev
, tocentry
.
The following elements occur in errorcode: text, alt
, anchor
, annotation
, biblioref
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), inlinemediaobject
, link
, olink
, phrase
(db._phrase), remark
, replaceable
, subscript
, superscript
, xref
.
<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> (non-fatal) error. </para> </article>
On most DOS-derived systems, functions signal a File Not Found error by returning 2 (ENOENT). This is usually a recoverable (non-fatal) error.
<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> (non-fatal) error. </para> </article>
On most UNIX systems, functions signal a File
Not Found error by returning
ENOENT, defined in
errno.h
. This is usually a
recoverable (non-fatal) error.