kernelv_ch_get_cont_visu_data()

Prototype

KERNELV_RETURN

kernelv_ch_get_cont_visu_data (unsigned long int chanIndex,
                                                     unsigned char* pData,
                                                     unsigned long int maxByteSize,
                                                     unsigned long int* retLength);

Description

Reads the contour visualisation of a channel. The format of the returned data is set by the parameter P-STUP-00039. A structure of type CONTOUR_VISU is returned followed by structures of type COUNTOUR_VISU_DATA_V0 … _V8.

If the memory provided by the calling application is not sufficient to return the structure CONTOUR_VISU, ERR_CNC_RET_MEMORY is returned and the minimum size of the required memory area is returned in retLength.

Parameter

Name	Type	Meaning
chanIndex	unsigned long	Channel index of the channel from which the variable is to be read.
pData	unsigned char*	Pointer to the memory area for return values.
maxByteSize	unsigned long	Size of the return memory.
retLength	unsigned long*	Number of bytes returned in pData.

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. The number of bytes required is returned in the returnSize parameter.