errorcode

errorcode — An error code.

Synopsis

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  alt
  anchor
  annotation
  biblioref
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
  inlinemediaobject
  link
  olink
  remark
  subscript
  superscript
  xref

Attributes

Common attributes and common linking attributes.

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.

Parents

This element occurs in 49 elements.

Children

This element contains 16 elements.

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example errorcode</title>
    
  4 <para>On most DOS-derived systems, functions signal a <errortext>File
    Not Found</errortext> error by returning
  6 <errorcode>2</errorcode> (<errorname>ENOENT</errorname>).  This is usually a
    <errortype>recoverable</errortype> (non-fatal) error.
  8 </para>
    
 10 </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.

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example errorcode</title>
    
  4 <para>On most UNIX systems, functions signal a <errorname>File
    Not Found</errorname> error by returning
  6 <errorcode>ENOENT</errorcode>, defined in 
    <filename>errno.h</filename>.  This is usually a
  8 <errortype>recoverable</errortype> (non-fatal) error.
    </para>
 10 
    </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.


equation		errorname