DocBook 5: The Definitive Guide

Name

ErrorCode -- An error code

Synopsis

Mixed Content Model

ErrorCode ::= ((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

Description

An error code. Error codes are often numeric, but in some environments they may be symbolic constants.

Processing expectations

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

Parents

These elements contain ErrorCode: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in ErrorCode: IndexTerm, InlineGraphic, InlineMediaObject, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

MoreInfo

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

See Also

ErrorName, ErrorType, MsgSet

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> On most DOS-derived systems, functions signal a <errorname>File Not Found</errorname> error by returning <errorcode>2</errorcode>. 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. This is usually a recoverable (non-fatal) error.

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <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.

Back to: DocBook: The Definitive Guide