kernelv_program_error_get_program_name
Prototype
KERNELV_RETURN
| GetProgramErrorProgramName(out string returnString); |
Description
Returns the program name of the active NC program.
The program name is specified at the start of the main program by a "%” character; for more information see [PROG]. If no program name was specified for the NC program, an empty string is returned.
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 name. |
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. |