10 Allgemeine Funktionen; Treiber Id-Nummer Lesen; Fehlermeldung In Text Umwandeln - HEIDENHAIN ND 287 Benutzerhandbuch

10 Allgemeine Funktionen

Alle allgemeinen Funktionen können als Rückgabewert die nachfolgend aufgeführten Fehlermeldungen liefern. Zusätzlich
dazu können sie individuell weitere Werte zurückgeben, die für jede Funktion separat aufgeführt werden.
Standard Rückgabewerte
ND2_NoError Funktionsaufruf erfolgreich
ND2_OutOfMemory Vom System kann nicht genügend Speicher allokiert werden
10.1

Treiber ID-Nummer lesen

Die Produktnummer (ID) des Treibers wird als C-String ausgegeben. Der String wird auf den Pointer „ident" gespeichert.
Über den Parameter „len" muss die Größe des Speichers für den String in Bytes angegeben werden. Falls der String inklusive
dem abschließenden Nullbyte länger als der Speicherbereich ist, wird eine Fehlermeldung generiert. Der Zielspeicher sollte
mindestens 9 Bytes groß sein.
Funktion
ND2_ERR ND2GetDriverID
Parameter
ident [Rückgabewert] Zielspeicher für den C-String
len Größe des Zielspeichers in Bytes
Rückgabewert
Der Rückgabewert liefert einen Status für den Funktionsaufruf. Neben den Standard Rückgabewerten können die nachfol-
gend aufgelisteten Fehlermeldungen auftreten.
ND2_BufferTooSmall
10.2

Fehlermeldung in Text umwandeln

Ein Fehlercode wird in eine Textmeldung umgewandelt und als C-String zurückgegeben. Im System sind für alle bekannten
Fehlercodes ein beschreibender Text und eine Kurzbezeichnung definiert. Über den Parameter „mnemonic" wird eine Kurz-
beschreibung der Fehlermeldung in Textform zurückgegeben (ca. 30-40 Zeichen). Der Parameter „message" enthält eine
ausführlichere Beschreibung (ca. 100-150 Zeichen). Wird für einen der Parameter „mnemonic" oder „message" ein NULL-
Pointer übergeben, so kopiert die Funktion den betreffenden Text nicht. Falls der Zielspeicher zu klein ist, um den gesamten
Text aufzunehmen, wird nur der erste Teil kopiert. Der String wird immer mit einem Null-Byte abgeschlossen.
Funktion
ND2_ERR ND2GetErrorInfo
Parameter
code Fehlercode, der in Text umgewandelt wird
mnemonic [Rückgabewert] Pointer auf den Zielspeicher für die Kurzbeschreibung
mnemlen Größe des Zielspeichers „mnemonic" in Bytes
message [Rückgabewert] Pointer auf den Zielspeicher für den Fehlertext
msglen Größe des Zielspeichers „message" in Bytes
Rückgabewert
Der Rückgabewert liefert einen Status für den Funktionsaufruf. Neben den Standard Rückgabewerten können die nachfol-
gend aufgelisteten Fehlermeldungen auftreten.
ND2_IllegalParameter
( char*
unsigned long
)
Zielspeicher zu klein
( ND2_ERR
char*
unsigned long
char*
unsigned long
)
Ungültiger Errorcode
ident,
len
code,
mnemonic,
mnemlen,
message,
msglen
45