Name

returnvalue — The value returned by a function

Synopsis

returnvalue ::= (text | phrase db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes and common linking attributes.

Description

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

Processing expectations

Formatted inline.

See Also

funcdef, funcparams, funcprototype, funcsynopsisinfo, function, paramdef, parameter, varargs, void

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.

Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial