errorcode

$Revision: 1666 $

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

errorcode — An error code

Synopsis

Mixed Content Model

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

Attributes

Common attributes

Name

Type

Default

moreinfo
Enumeration:
none
refentry
"none"

Parameter Entities

The following parameter entities contain errorcode:

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

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

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Children

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

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the ErrorCode.

See Also

errorname, errortext, errortype, msgset.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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>

On most DOS-derived systems, functions signal a File Not Found error by returning 2 (ENOENT). This is usually a recoverable (non-fatal) error.

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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>

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.