returnvalue

$Revision: 1.3 $

$Date: 2002/06/12 11:18:33 $

returnvalue — The value returned by a function

Synopsis

Mixed Content Model

returnvalue ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
 beginpage)*

Attributes

Common attributes

DocBook NG “Bourbon” Content Model

returnvalue ::=

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

Description

ReturnValue identifies the value returned by a function or command.

Processing expectations

Formatted inline.

Children

The following elements occur in returnvalue: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.

See Also

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

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The <function>open</function> function returns <returnvalue>2</returnvalue>
(<errorname>ENOFILE</errorname>) if the file does not exist.
</para>

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