CXI-Basis-Programmierreferenz / Allgemeines /

Bezeichnungen und Konventionen

Bezeichnungen und Konventionen:

Funktionen für C++ erscheinen mit dieser Markierung. Bei Verwendung eines C-Compilers können diese Funktionen nicht benutzt werden. Diese Dokumentation beschreibt in erster Linie die C++-Schnittstelle, nicht alle der darunter liegenden C-Funktionen werden aufgeführt.

Funktionen, die auch unter C benutzt werden können, werden kursiv angezeigt, sofern das verwendete Hilfesystem dies zulässt. Wird ein C++-Compiler eingesetzt, sind diese Funktionen ebenfalls verfügbar. Um Unübersichtlichkeit zu vermeiden, sind bei C-Funktionen in der Regel nur diejenigen Angaben aufgeführt, die für den Aufruf der Funktion notwendig sind, Zusätze (z.B. Aufrufkonvention CXIGLOBALFUNC) befinden sich nur im Header (CXIB.H). Dies gilt auch, wenn die 'Funktion' als Makro implementiert ist.

Stufe 1: Notwendige Information
Abschnitte mit dieser Markierung sind für die Benutzung von CXIB notwendig. Hierzu gehören Texte, die für das Verständnis und den Einsatz zur Laufzeit wichtig sind, und die Beschreibungen der wichtigsten Funktionen. Die meisten Programme benötigen ausschließlich die Funktionalität der Stufe 1.

Stufe 2: Anwendungsschnittstelle
Abschnitte der Stufe 1 und der Stufe 2 zusammen beschreiben den Teil der Anwendungsschnittstelle, mit dem fast jedes Programm auskommt.

Stufe 3: Spezialanwendungen
Die Abschnitte der Stufe 3 beschreiben Spezialanwendungen. Hierzu gehören Zugriffsfunktionen, die zur Optimierung verwendet werden, weitere Datentypen und der nicht für C++ relevante Teil der C-Schnittstelle.

Stufe 4: Interna
In der Stufe 4 befinden sich solche Funktionen, die für die interne Verarbeitung benötigt werden. Erweiterungen des CXIB-Systems nutzen diese Aufrufe. Sie können Stufe 4 für eigene Erweiterungen einsetzen, achten Sie jedoch genau auf die Dokumentation, denn eine fehlerhafte Benutzung derartiger Funktionen kann zu Programmabstürzen und Datenverlust führen!

Stufe 5: Veraltete Information
Mit der Markierung für Stufe 5 sind Texte und Funktionen gekennzeichnet, die nicht mehr aktuell sind. Sie beziehen sich auf noch im Umlauf befindliche ältere Versionen der LIB/DLL. Die Funktionalität wurde/wird gestrichen oder wird demnächst verändert.

Portabilität eingeschränkt
Funktionen mit dieser Kennung verhalten sich bei den einzelnen Systemen unterschiedlich. Diese Markierung stellt nur eine Warnung dar, bei entsprechender Programmierung kann Portabilität gewahrt werden. Ebenfalls mit diesem Zeichen sind Funktionen gekennzeichnet, die unter allen momentan verfügbaren Implementationen von CXI realisiert sind, dies aber möglicherweise für weitere Portierungen von CXI nicht zutreffen könnte.

Keine Portabilität
Funktionen und globale Variablen mit dieser Kennung sind nicht portabel oder nicht unter allen Systemen verfügbar. Solche Funktionen sollten nur dann eingesetzt werden, wenn nur für ein System entwickelt wird oder die Aufrufe im Source (z.B. mit #ifdef) speziell behandelt werden. Bei globalen Variablen und SET-Befehlen kann häufig auf die Sonderbehandlung verzichtet werden, da entsprechende Definitionen von CXI unter anderen Systemen ignoriert werden.

Systemspezifisch
Zur besonderen Hervorhebung sind einige der systemabhängigen Textpassagen in dieser Dokumentation mit dem entsprechenden Symbol gekennzeichnet. Dieses Symbol ist gleichzeitig eine Referenz auf die Beschreibung zum jeweiligen System.

Baustelle: Dokumentation wird noch erweitert
An dieser Stelle wird die Dokumentation noch erweitert oder aktualisiert.