errorname

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

errorname — An error name

Synopsis

Mixed Content Model

errorname ::=
(%smallcptr.char.mix;)*

Attributes

Common attributes

Parameter Entities

The following parameter entities contain errorname:

Parameter Entities
%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%refinline.char.mix;%refname.char.mix;%tbl.entry.mdl;
%tech.char.class;%title.char.mix; 

Description

ErrorName holds the symbolic name of an error.

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”).

Prior to DocBook V4.2, the ErrorName element was the recommended element for error messages. However, this left no element for symoblic names, so the ErrorText element was added and the semantics of the error elements adjusted slightly.

Processing expectations

Formatted inline.

Children

The following elements occur in errorname: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.

See Also

errorcode, errortext, errortype, msgset.

Examples

For examples, see errorcode, returnvalue.