returnvalue

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

returnvalue — The value returned by a function

Synopsis

Mixed Content Model

returnvalue ::=
(%smallcptr.char.mix;)*

Attributes

Common attributes

Parameter Entities

The following parameter entities contain returnvalue:

Parameter Entities
`%cptr.char.mix;`	`%ndxterm.char.mix;`	`%para.char.mix;`
`%refinline.char.mix;`	`%refname.char.mix;`	`%tbl.entry.mdl;`
`%tech.char.class;`	`%title.char.mix;`

Description

ReturnValue identifies the value returned by a function or command.

Processing expectations

Formatted inline.

Parents

These elements contain returnvalue: action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.

Children

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

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.


replaceable		revdescription