kernelv_ch_program_start()

Prototype

KERNELV_RETURN

kernelv_ch_program_start (unsigned long chanIndex,
                                            char* name,
                                            unsigned long mode);

Description

Starts an NC program in the specified channel.

Parameter

Name

Type

Meaning

chanIndex

unsigned long

Channel index of the channel in which the program is to be started.

name

char*

Name of the program to be started.

mode

unsigned long*

Execution mode in which the program is started.

Possible execution modes, see E_KERNELV_PROG:START_MODE.

Return values

Symbol

Value

Meaning

RET_FINISHED

0

The function was executed without error.

RET_BUSY

1

The function is currently being executed, but has not yet been completed.

The API function must continue to be called.

ERR_INVALID_CHAN

-1

The transferred channel index is higher than the number of configured channels - 1

ERR_PROG_NAME_LENGTH

-2

The transferred program name is longer than permitted.

ERR_CNC_NOT_INIT

-3

The simulation CNC kernel was not yet initialised.

ERR_INVALID_START
_MODE

-25

An invalid start mode was transferred when the function kernelv_ch_program_start() was started.

For valid execution mode values, see E_KERNELV_PROG_START_MODE.