kernelv_ch_get_cs_name()

Prototyp

KERNELV_RETURN

kernelv_ch_get_cs_name(unsigned long int chanIndex,
                                         unsigned short csIndex,
                                         char *name,
                                         unsigned long int bufferSize,
                                         unsigned long int *retBytes);

Beschreibung

Liefert die im NC-Programm definierte Bezeichnung des Koordinatensystems zurück.

Falls an der durch csIndex definierten Stelle im Koordinatensystem-Stack kein Koordinatensystem definiert ist, wird eine leere Zeichenkette zurückgegeben und der Rückgabewert der Funktion ist ERR_CNC_NO_DATA.

Parameter

Name	Typ	Bedeutung
chanIndex	unsigned long	Kanalindex des Kanals.
csIndex	unsigned short	Index des Koordinatensystems im Koordinatensystem-Stack.
name	char*	Zeiger auf den Speicherplatz für den Koordinatensystemnamen.
nameLength	unsigned long	Länge des Speicherbereiches für den Koordinatensystemnamen.
returnLength	unsigned long*	Zeiger auf den Wert, in den die tatsächlich zurückgegebene Anzahl Bytes geschrieben werden soll. Es wird die Anzahl der Zeichen des Koordinatensystemnamens + 1 zurückgegeben. Falls der übergebene Speicher zu klein für die Rückgabe des Wertes ist, wird der Rückgabewert ERR_CNC_RET_MEMORY zurückgegeben und es wird über diesen Parameter die benötigte Speichergröße zurückgegeben.

Rückgabewerte

Symbol	Wert	Bedeutung
RET_FINISHED	0	Die Funktion wurde fehlerfrei durchgeführt.
ERR_INVALID_CHAN	-1	Der übergebene Kanalindex ist größer als die Anzahl der konfigurierten Kanäle -1
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. In diesem Fall wird über returnLength die zur Rückgabe benötigte Mindestgröße zurückgegeben.
ERR_READ_ERR	-26	Beim Lesen von Daten aus der kernelv-DLL ist ein Fehler aufgetreten.
ERR_CNC_NO_DATA	-28	Die angeforderten Daten sind nicht verfügbar. An der durch den Aufrufparameter csIndex angegebenen Stelle im Koordinatensystem-Stack steht kein definiertes Koordinatensystem. Es wird eine leere Zeichenkette zurückgegeben.
ERR_INVALID_PARAMETER	-30	Es wurde ein ungültiger Parameter übergeben: Der in Parameter csIndex übergebene Koordinatensystemindex ist größer als der maximal mögliche Index im Koordinatensystem-Stack.