kernelv_get_error_message_string()

Prototyp

KERNELV_RETURN

kernelv_get_error_message_string(char * string,
                                         unsigned long int *length);

Beschreibung

Liefert die formatierte Zeichenkette einer zuvor mit kernelv_read_error() gelesenen Fehlermeldung als Zeichenkette zurück. Die zurückgegebene Zeichenkette ist identisch mit der von der Funktion kernelv_get_error() zurückgegebenen Zeichenkette.

Beim Aufruf ist im Parameter 'string' ein Zeiger auf den Speicher für die zurückzugebende Zeichenkette zu übergeben, in 'length' die Größe dieses Speicherbereiches. Falls der bereitgestellte Speicher ausreichend für die Rückgabe der Zeichenkette ist, wird in 'length' die Länge der zurückgegebenen Zeichenkette zurückgegeben.

Falls der vom Aufrufer bereitgestellte Speicher zu klein für die zurückzugebende Zeichenkette ist, wird der Rückgabewert ERR_CNC_RET_MEMORY zurückgegeben. In Parameter 'length' steht in diesem Fall die zur Rückgabe der Zeichenkette benötigte Größe in Bytes.

Parameter

Name

Typ

Bedeutung

string

char*

Zeiger auf Zeichenkette für Fehlermeldungs­string. Der Speicher ist vom Aufrufer bereitzustellen.

length

unsigned long*

Größe des Speichers für den Fehlermeldungsstring. Wenn der von der Simulations-CNC erzeugte Fehlermeldungs­string länger ist als der bereitgestellte Speicher, wird kein String zurückgeben. Zurückgegeben wird entweder die Länge der zurückgegebenen Zeichenkette oder die zur Rückgabe benötigte Größe des Speicherbereiches.

Rückgabewerte

Symbol

Wert

Bedeutung

RET_FINISHED

0

Die Funktion wurde fehlerfrei durchgeführt

ERR_CNC_NOT_INIT

-3

Der Simulations-CNC-Kern ist noch nicht initialisiert.

ERR_CNC_RET_MEMORY

-4

Der oder die Rückgabewerte passen nicht in den bereitgestellten Speicher. Im Parameter 'returnSize' wird die Anzahl der benötigten Bytes zurückgegeben.