constant

constant — A programming or system constant.

Synopsis

constant ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “limit”

Description

A constant identifies a value as immutable. It is most often used to identify system limitations or other defined constants.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

class

Identifies the class of constant

Enumerated values:
“limit”

The value is a limit of some kind

Parents

These elements contain constant: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, computeroutput, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), initializer, link, literallayout, member, meta (db.meta.content), olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.

Children

The following elements occur in constant: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

See Also

Related elements: command, computeroutput, literal, markup, option, optional, parameter, prompt, replaceable, tag, userinput, varname.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example constant</title>
  | 
  |<para>In ACL, <constant>main::PCS</constant> contains the path component
5 |separator character.
  |</para>
  | 
  |</article>

In ACL, main::PCS contains the path component separator character. 

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example constant</title>
  | 
  |<para>The maximum legal length for a path name is 
5 |<constant class='limit'>PATH_MAX</constant>, defined in
  |<filename class='headerfile'>limits.h</filename>.
  |</para>
  | 
  |</article>

The maximum legal length for a path name is PATH_MAX, defined in limits.h.