kernelv_ch_get_state()

Prototype

KERNELV_RETURN

kernelv_ch_get_state (unsigned long int chanIndex,
                                    KERNELV_CHANNEL_STATE *state);

Description

Reads the channel's current state.

Parameter

Name

Type

Meaning

chanIndex

unsigned long

Channel index.

state

KERNELV_CHANNEL_STATE *

Pointer to the state to be returned.

Return values

Symbol

Value

Meaning

RET_FINISHED

0

The function was executed without error.

ERR_INVALID_CHAN

-1

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

ERR_CNC_NOT_INIT

-3

The simulation CNC kernel was not yet initialised.

ERR_INTERNAL_ERROR

-11

An internal error has occurred in the DLL.