kernelv_ch_axis_get_offsets()

Prototype

KERNELV_RETURN

kernelv_ch_axis_get_offsets(unsigned long int chanIndex,
                                               unsigned long int axisIndex,
                                               unsigned short int csIndex,
                                               signed long int *offsets,
                                               unsigned long int bufferSize,
                                               unsigned long int *retBytes);

Description

Returns the axis-specific offsets in the coordinate system specified by the parameter csIndex.

The parameter axisIndex identifies the index of the axis in the NC channel specified by ChanIndex.

A vector with eight elements is returned. It lists the offsets imported by the various NC commands for the axis defined by axisIndex.

The enumeration KERNELV_AXIS_OFFSET_TYPES specifies the assignment of the index in the vector to the various offset types.

Parameter

Name	Type	Meaning
chanIndex	unsigned long	Channel index of the channel.
axisIndex	unsigned long	Index of the axis in the NC channel.
csIndex	unsigned short	Index of the coordinate system in the coordinate system stack.
offsets	signed long*	Pointer to the memory location for the offset vector.
nameLength	unsigned long	Length of the memory area for the rotation matrix must be at least 8 x sizeof (signed long int).
returnLength	unsigned long*	Pointer to the value to which the actually returned number of bytes is to be written. If the transferred memory is too small for the return value, the return value ERR_CNC_RET_MEMORY is returned and this parameter returns the required memory size.

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_CNC_RET_MEMORY	-4	The return value(s) does/do not fit into the memory provided. In this case, the minimum size required for the return is returned in returnLength.
ERR_READ_ERR	-26	An error occurred on reading data from the kernelv DLL.
ERR_CNC_NO_DATA	-28	The requested data is not available. No coordinate system is defined in the coordinate system stack at the location specified by the call parameter csIndex. A zero vector is returned.
ERR_INVALID_PARAMETER	-30	An invalid parameter was transferred: The coordinate system index transferred in the parameter csIndex is higher than the maximum possible index in the coordinate system stack.