Notation

Introduction > About this manual > Notation

Notation

The following typographic conventions apply throughout this manual:

Code extracts and file names are written in courier typeface.

Important ideas are emphasized like this.

Naming Conventions

Throughout this manual, we will refer to the “application” as a program that you have written to make use of data in one or more databases, managed by one or more RDBMSs, all linked by Rogue Wave DB Link.

Basic type names begin with Il as they come from the common basic Rogue Wave Views library (ilog.lib or libilog.a).

The names of classes, and functions defined in the Rogue Wave DB Link library begin with Ild.

Constants, error codes, and options are written in uppercase letters, separated by an underscore “_” if their name consists of more than one word:

ILD_BAD_FILE

The names of classes, functions, C++ types, and enumerated values (enum) are written as concatenated, capitalized words:

class IldDbms;

enum IldEntityType {IldTableEntity, IldViewEntity, IldADTEntity, IldCallableEntity, IldSynonymEntity};

IldDbms* IldNewDbms(const char*, const char*);

The first word in names of arguments, instances, and member functions begins with a lowercase letter. Other words in such a name begin with an uppercase letter. Data members of classes and fields in structures are prefixed by an underscore “_”:

IldRequest::getByteValue();

typedef struct {

IlInt _size;

IldByte* _value;

}

Accessors begin with the keyword get followed by the name of the data member:

const char* getCursorName() const;

Accessors for Boolean members begin with is followed by the name of the data member:

IlBoolean isConnected() const;

Modifiers begin with the keyword set followed by the name of the data member:

IldRequest& setCursorName (const char* cursName);

Version 5.8