This is an alpha version of this book.

errorcode

Name

errorcode — An error code

Synopsis

Mixed Content Model

errorcode ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
 beginpage)*

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.

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, 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 <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 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.

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.