Readme | Library | Examples | Utilities

Using This Documentation

The DataReel class library is documented by category with a detailed description and usage note for each function. Block diagrams are included with the core library components. The diagrams are intended to give you a broad overview the library component and its interaction with other library components. All the documents presented here are published in an HTML format. The contents of each page is broken down by all applicable topics for the given module:

Overview - Detailed description of the module
Conditional Directives - Platform specific directives
Constants - Constants used with this module
Type Definitions - Type definitions used with the module
Enumerations - Enumerated types used with the module
Data Structures - Data structures used with the module
Data Members - Any public data members
Functions - Usage description for public/protected functions

Functions are listed in alphabetical order and include a return value, class scope, and any default arguments:

int gxClass::Foo(const char *s, int i = 0, int y = 0) - Usage description

NOTE: For the latest usage for any of the classes or functions documented here please review the example programs . The class and function documentation may not be as current as the examples.

Naming Convention

All core library component names are prefaced by letters gx. GX is a short acronym for the compound term: General-Purpose Platform Interoperable Code. The GX acronym was derived specifically to avoid name conflicts with other libraries.

DataReel Copyright © 2001-2024 DataReel Software Development