DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

returnvalue

returnvalue — The value returned by a function.

Synopsis

returnvalue ::= [-]

Description

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

Processing expectations

Formatted inline.

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.

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.