Preface

Conventions used for reference entries

Each entry is headed by the symbol name and type, followed by a number of fields providing further details. These fields consist of a subset of the following: "Package", "Summary", "Syntax", "Superclasses", "Subclasses", "Slots", "Accessors", "Readers", "Compatibility Note", "Description", "Examples", and "See Also".

The default package containing each symbol is theCAPI package in the CAPI reference chapter, and thegp package in the graphics ports reference chapter, unless stated otherwise in the "Package" section of an entry.

Entries with a long "Description" section usually have as their first field a short "Summary" providing a quick overview of the purpose of the symbol being described.

The "Syntax" section provides details of the arguments taken by the functions and macros. Variable arguments for the command are printed like this.

Only immediate sub- and superclasses are detailed in the "Subclasses" and "Superclasses" sections of each CAPI class entry.

Examples of the use of commands are given under the "Examples" heading. Some example files can also be found in your installation directory undercurrent-lib/examples/capi/.

Finally, the "See also" section provides a reference to other related symbols.