Fehlermeldung als Zeichenkette auslesen kernelv_get_error()

Prototyp

KERNELV_RETURN

kernelv_get_error (unsigned long* errorId,
                              char* messageString,
                              unsigned long maxStringLength,
                              unsigned long* returnLength);

Beschreibung

Fehlermeldungen der Simulations-CNC auslesen: Es werden die Fehlermeldungen sämtlicher Kanäle ausgelesen. Da während eines CNC-Zyklus mehrere Fehlermeldungen auftreten können, ist die Funktion zyklisch aufzurufen, bis die Funktion die Error-Id 0 zurückgibt.

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 returnLength steht in diesem Fall die zur Rückgabe der Zeichenkette benötigte Größe in Bytes.

Dem Parameter "errorId" wird in jedem Fall ein Wert zugewiesen.

Bei der gleichzeitigen Verwendung von dieser Funktion mit kernelv_read_error() ist zu beachten, dass diese Funktion intern ebenfalls kernelv_read_error() aufruft. Um bei Verwendung der Funktion kernelv_read_error() einen Fehlerstring zu lesen, sollte die Funktion kernelv_get_error_message_string() verwendet werden.

Parameter

Name	Typ	Bedeutung
errorId	unsigned long*	Zeiger auf Fehlermeldungs-ID.
messageString	char*	Zeiger auf Zeichenkette für Fehlermeldungsstring. Der Speicher ist vom Aufrufer bereitzustellen.
maxStringLength	unsigned long*	Größe des Speichers für den Fehlermeldungsstring. Wenn der von der Simulations-CNC erzeugte Fehlermeldungsstring länger ist als der bereitgestellte Speicher, wird kein String zurückgegeben.
returnLength	unsigned long*	Größe des erwarteten Speichers.

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.