Organization of this Reference

This reference guide is generated from source code comments. It replaces the former suite of reference guides for SourcePro®. Below are some guidelines on how to navigate this new reference.

Modules: This tab provides a view into the product similar to the earlier suite of reference guides, organized on the top level by product, and on the next level by module. At each level you will find a list of the classes and related functions for that level. Note that the DB Access Module system and environmental handle classes, formerly documented in the user guides, have been moved to this reference guide.

SourcePro DB

  DB Interface Module
    ...
  Access Module System and Environment Handles
    ...

SourcePro Core

  Essential Tools Module
    ...
  Internationalization Module
    ...
  Advanced Tools Module
    ...
  Threads Module
    ...
  XML Streams Module
    ...

SourcePro Analysis

  Currency Module
    ...
  Business Analysis Module
    ...
  Essential Math Module
    ...
  Linear Algebra Module
    ...

SourcePro Net Classes

  Internet Protocols Module
    ...
  Essential Networking Module
    ...
  Secure Communications Module
    ...

Classes: Contains these four listings:

• Alphabetical Index: A concise alphabetical index of the classes in the API.
• Annotated List: An annotated alphabetical list of the classes in the API.
• Class Hierarchy: A hyperlink class hierarchy.
• Class Members: A comprehensive index of class members and related functions in the API.

Search

Every page has a search box that let's you search on symbols: classes, functions, variables, typedefs, enumerations, enumerators, and friends. To be clear: this is not full-text search, so searching on "hashmap" will return no matches, but 'hash' will because many classes have a hash() function.

A dropdown menu on the left side of the search box lets you restrict the search to a single type of symbol, with the default being all symbols. The results show matching symbols, and if you click on one, you will see a list of all places where the symbol is documented. Click the close icon on the right side of the search box to close the results box.

Related Pages: Contains the sub page Deprecated List, a list of all deprecated classes, members, and non-members.

Inherited Members

The main class description page only documents members declared in the class. That is, it does not document inherited members inline. To see the list of all members, whether declared in the class or inherited from a base class, click the List of all members link near the top of the class description page.

Conditional code elements

Some code elements are tagged as conditional, as indicated in the description by:

Condition: Reason for the limitation ...

Most commonly this is because the code element depends on functionality that not all compilers support, such as recent changes to the C++ standard. In some cases, they reflect specific problems related to a platform or compiler. Note that use of these code elements may limit the portability of your code.