kernelv_get_api_version()

Prototype

KERNELV_RETURN

kernelv_get_api_version (char* versionString,
unsigned long maxStringLength,
unsigned long* returnSize);

Description

Reads the API version string.

Parameter

Name	Type	Meaning
versionString	char*	Pointer to the version string storage location. The application must provide sufficient memory.
maxStringLength	unsigned long	Length of the memory provided by the application (in bytes).
returnSize	unsigned long*	Length of the version string returned. The value 0 is returned if an error has occurred.

Return values

Symbol	Value	Meaning
RET_FINISHED	0	The function was executed without error.
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 required bytes including the terminating zero is returned in the returnSize parameter.