returnvalue

returnvalue — The value returned by a function

Synopsis

Content Model

returnvalue ::=

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

Attributes

Common attributes and common linking attributes.

Description

ReturnValue identifies the value returned by a function or command.

Processing expectations

Formatted inline.

Parents

These elements contain returnvalue: bridgehead, citation, citetitle, classsynopsisinfo, emphasis (db.emphasis), entry, firstterm, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, link, literallayout, member, olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.

Children

The following elements occur in returnvalue: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example returnvalue</title>

<para>The <function>open</function> function returns <returnvalue>2</returnvalue>
(<errorname>ENOFILE</errorname>) if the file does not exist.
</para>

</article>

The open function returns 2 (ENOFILE) if the file does not exist.

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:56 $.


replaceable		revdescription