constant

$Revision: 1.3 $

$Date: 2002/06/12 11:18:07 $

constant — A programming or system constant

Synopsis

Mixed Content Model

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

Attributes

Common attributes

Name

Type

Default

class
Enumeration:
limit
None

DocBook NG “Bourbon” Content Model

constant ::=

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

Additional attributes: (Required attributes, if any, are bold)

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

Children

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

Attributes

class

Class identifies constants that are system or application limits (for example, the maximum length of a filename).

See Also

command, computeroutput, literal, markup, option, optional, parameter, prompt, replaceable, sgmltag, userinput, varname.

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>
In ACL, <constant>main::PCS</constant> contains the path component
separator character.
</para>

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

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The maximum legal length for a path name is 
<constant class='limit'>PATH_MAX</constant>, defined in
<filename class='headerfile'>limits.h</filename>.
</para>

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