constant
constant — A programming or system constant.
Synopsis
- Zero or more of:
- text
phrase
(db._phrase)replaceable
- Graphic inlines
- Indexing inlines
- Linking inlines
- 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.
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.
- class
Identifies the class of constant
Enumerated values: “limit” The value is a limit of some kind
This element occurs in 51 elements.
This element contains 16 elements.
See Also
command
, computeroutput
, literal
, markup
, option
, optional
, parameter
, prompt
, replaceable
, tag
, userinput
, varname
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example constant</title> 4 <para>In ACL, <constant>main::PCS</constant> contains the path component separator character. 6 </para> 8 </article>
In ACL, main::PCS
contains the path component
separator character.
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example constant</title> 4 <para>The maximum legal length for a path name is <constant class='limit'>PATH_MAX</constant>, defined in 6 <filename class='headerfile'>limits.h</filename>. </para> 8 </article>
The maximum legal length for a path name is
PATH_MAX
, defined in
limits.h
.