AuxVersion functions

Functions
EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV	GetAuxVersion (void)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV	AuxVersion_release (AUXVERSIONHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getFPGAVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getSSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getFrontVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getCCAuxVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getOSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getCCAuxDrvVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getCanFdMcuVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getCanFdApiVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getFullOSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	AuxVersion_getFullCCAuxVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)

Detailed Description

Functions in the AuxVersion class

Function Documentation

AuxVersion_getCanFdApiVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCanFdApiVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the CAN FD Windows API version.

Supported Platform(s): XM9

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

AuxVersion_getCanFdMcuVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCanFdMcuVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the CAN FD microcontroller firmware version.

Supported Platform(s): XM9

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getCanFdMcuVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "CAN FD MCU Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getCCAuxDrvVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCCAuxDrvVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the CrossControl CCAux CCAuxDrv version. Can be used to check that the correct driver is loaded.

Supported Platform(s): XL, XM

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getCCAuxDrvVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "CCAux Driver Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getCCAuxVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCCAuxVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the CrossControl CCAux API version. CCAux includes: CCAuxService/ccauxd - Windows Service/Linux daemon. CCAux2.dll/libccaux2 - The implementation of this API.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getCCAuxVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "CC Aux Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout <<
    (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getFPGAVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFPGAVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the FPGA software version

Supported Platform(s): XL, XM, XS, XA, VS

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getFPGAVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "FPGA Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getFrontVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFrontVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the front microcontroller software version

Supported Platform(s): XL, XM, XS, XA

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getFrontVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "Front Micro Controller Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getFullCCAuxVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFullCCAuxVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build,
		char_t *	tag,
		uint32_t	len
	)

Get the CrossControl CCAux API version including tag name. CCAux includes: CCAuxService/ccauxd - Windows Service/Linux daemon. CCAux2.dll/libccaux2 - The implementation of this API.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number
tag	Tag name
len	Number of chars to read from the tag name (max 100)

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getCCAuxVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "CC Aux Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout <<
    (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getFullOSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFullOSVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build,
		char_t *	tag,
		uint32_t	len
	)

Get the CrossControl Operating System version including tag name.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number
tag	Tag name
len	Number of chars to read from the tag name (max 100)

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

AuxVersion_getOSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getOSVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the CrossControl Operating System version.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getOSVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "Operating System Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_getSSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getSSVersion	(	AUXVERSIONHANDLE	,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	release,
		uint8_t *	build
	)

Get the System Supervisor software version

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Parameters

major	Major version number
minor	Minor version number
release	Release version number
build	Build version number

Returns

error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = AuxVersion_getSSVersion(
    pAuxVersion,
    &major,
    &minor,
    &release,
    &build);

  cout << setw(column_width) << "System Supervisor Version: ";
  if (CrossControl::ERR_SUCCESS == err)
    cout << (int) major << "." <<
    (int) minor << "." <<
    (int) release << "." <<
    (int) build << endl;
  else
    cout << "unknown" << endl;

AuxVersion_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_release

(

AUXVERSIONHANDLE

)

Delete the AuxVersion object.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Returns

-

Example Usage:

  AUXVERSIONHANDLE pAuxVersion = ::GetAuxVersion();
  assert (pAuxVersion);

  output_versions(pAuxVersion);

  AuxVersion_release(pAuxVersion);

GetAuxVersion()

EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetAuxVersion

(

void

)

Factory function that creates instances of the AuxVersion object.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VS, VI2

Returns

AUXVERSIONHANDLE to an allocated AuxVersion object. The returned handle needs to be deallocated using the AuxVersion_release(AUXVERSIONHANDLE) method when it's no longer needed. Returns NULL if it fails to allocate memory.

Example Usage:

  AUXVERSIONHANDLE pAuxVersion = ::GetAuxVersion();
  assert (pAuxVersion);

  output_versions(pAuxVersion);

  AuxVersion_release(pAuxVersion);