1.2 Organization of the Reference Guide

Following this overview chapter is an alphabetical listing of the classes in the DB XA Module.

The DB XA Module Reference Guide lists the classes of the DB XA Module in alphabetical order. Each class entry includes the following information:

• The class name discussed in the entry

• The inheritance

The following convention is used to show that class A inherits from class B:

A  B

When a class inherits from more than one class, or there are multiple levels of inheritance, all of its inheritance relationships are shown. For example, the following illustration indicates that class A inherits from class B and from class C, which inherits from class D.

    B
A
    C  D

The notation used here is the standard UML arrow.

• A Synopsis indicating the header file(s) associated with the class.

• A brief Description of the class.

• An Example that uses the class.

• Descriptions of the various class functions. These are organized in categories according to their general use; for example, Constructors, Operators, and Public Member Functions.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.