returnvalue
returnvalue — The value returned by a function.
Synopsis
- Zero or more of:
- text
phrase(db._phrase)replaceable- Graphic inlines
![[-]](figs/web/nav/down.gif)
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
altanchorannotationbibliorefindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxref
Attributes
Description
A returnvalue identifies the value returned by
a function or command.
Processing expectations
Formatted inline.
Parents ![[+]](figs/web/nav/right.gif)
This element occurs in 50 elements.
Children
This element contains 16 elements.
See Also
funcdef, funcparams, funcprototype, funcsynopsisinfo, function, paramdef, parameter, varargs, void
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example returnvalue</title> 4 <para>The <function>open</function> function returns <returnvalue>2</returnvalue> (<errorname>ENOFILE</errorname>) if the file does not exist. 6 </para> 8 </article>
The open function returns 2
(ENOFILE) if the file does not exist.