returnvalue

returnvalue — The value returned by a function.

Synopsis

returnvalue ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

Description

A returnvalue identifies the value returned by a function or command.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain returnvalue: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, code, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), 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, type.

Children

The following elements occur in returnvalue: 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: funcdef, funcparams, funcprototype, funcsynopsisinfo, function, paramdef, parameter, varargs, void.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example returnvalue</title>
  | 
  |<para>The <function>open</function> function returns <returnvalue>2</returnvalue>
5 |(<errorname>ENOFILE</errorname>) if the file does not exist.
  |</para>
  | 
  |</article>

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