kernelv_program_error_get_file_name

Prototyp

KERNELV_RETURN

kernelv_program_error_get_file_name(char *return_string,
unsigned long * returnLength);

Beschreibung

Liefert den Dateinamen des aktiven NC-Programms zurück.

Falls das Programm durch Angabe eines absoluten Programmnamens gestartet wurde, wird der komplette Programmname zurückgegeben.

Falls die CNC-Steuerung das NC-Programm unter Benutzung eines Suchpfades öffnete, wird von dieser Funktion der beim Programmstart angegebene Dateiname zurückgegeben, der verwendete Suchpfad kann mit der Funktion kernelv_program_error_get_path() abgefragt werden.

Die Funktion liefert die Anzahl der zurückgelieferten Bytes in returnLength zurück, d. h. die den String terminierende Null wird mitgezählt.

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.

Parameter

Name

Typ

Bedeutung

return_string

char*

Zeiger auf Zeichenkette für den Programmpfad. Der Speicher ist vom Aufrufer bereitzustellen.

return_length

unsigned long*

Größe des Speichers für den Rückgabewert. Wenn die zurückzugebende Zeichenkette länger ist als der bereitgestellte Speicher, wird nichts 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_RET_MEMORY	-4	Der oder die Rückgabewerte passen nicht in den bereitgestellten Speicher. Im Parameter length wird die Anzahl der benötigten Bytes zurückgegeben.
ERR_CNC_NO_DATA	-28	Die angeforderten Daten sind nicht verfügbar. Es liegen keine NC-programmspezifischen Daten zu einem CNC-Fehler vor.