kernelv_program_error_get_file_name
Prototype
KERNELV_RETURN
| ProgramErrorGetFileName (out string returnString); |
Description
Returns the file name of the active NC program.
If the program was started by specifying an absolute program name, the compete program name is returned.
If the CNC controller opened the NC program by using a search path, this function returns the file name specified at program start. The search path used can be requested by the function kernelv_program_error_get_path().
If the memory provided by the calling application is too small for the string to be returned, the return value ERR_CNC_RET_MEMORY is returned
Parameter
Name | Type | Meaning |
returnString | out string | String for program path. |
Return values
Symbol | Value | Meaning |
RET_FINISHED | 0 | The function was executed without error. |
ERR_CNC_RET_MEMORY | -4 | The return value(s) does/do not fit into the memory provided. The number of bytes required is returned in the ‘length’ parameter. |
ERR_CNC_NO_DATA | -28 | The requested data is not available. There is no available NC program specific data relating to an CNC error. |