About functions

Functions
EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV	GetAbout (void)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV	About_release (ABOUTHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainPCBSerial (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getUnitSerial (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainPCBArt (ABOUTHANDLE, char_t *buff, int32_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainManufacturingDate (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainHWversion (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainProdRev (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getMainProdArtNr (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfETHConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfCANConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfVideoConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfUSBConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfSerialConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfDigIOConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsDisplayAvailable (ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsTouchScreenAvailable (ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsPCBBluetoothAvailable (ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getDisplayResolution (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getAddOnPCBSerial (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getAddOnPCBArt (ABOUTHANDLE, char_t *buff, int32_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getAddOnManufacturingDate (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getAddOnHWversion (ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsWLANMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsGPSMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsGPRSMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsBTMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getFrontPcbRev (ABOUTHANDLE, uint8_t *major, uint8_t *minor)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsIOExpanderMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIOExpanderValue (ABOUTHANDLE, uint16_t *value)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_hasOsBooted (ABOUTHANDLE, bool *bootComplete)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getIsAnybusMounted (ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfCfgInConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfPWMOutConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfButtons (ABOUTHANDLE, int32_t *numbuttons)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getNrOfAnalogInputs (ABOUTHANDLE, int32_t *numanalogins)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_getUserEepromData (ABOUTHANDLE, char_t *buff, uint16_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	About_setUserEepromData (ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length)

Detailed Description

Functions in the About class

Function Documentation

About_getAddOnHWversion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnHWversion	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get Add on hardware version.

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

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getAddOnHWversion(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Add on hardware version: " << buffer << endl;

About_getAddOnManufacturingDate()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnManufacturingDate	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get Add on manufacturing date.

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

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getAddOnManufacturingDate(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Add on manufacturing date: " << buffer << endl;

About_getAddOnPCBArt()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnPCBArt	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	length
	)

Get Add on PCB article number.

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

Parameters

buff	Text output buffer.
length	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getAddOnPCBArt(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Add on PCB article number: " << buffer << endl;

About_getAddOnPCBSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnPCBSerial	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get Add on PCB serial number.

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

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getAddOnPCBSerial(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Add on PCB serial number: " << buffer << endl;

About_getDisplayResolution()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getDisplayResolution	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get display resolution.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned. The display resolution will be returned in the format "1024x768"

Returns

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

Example Usage:

    err = About_getDisplayResolution(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Display resolution: " << buffer << endl;

About_getFrontPcbRev()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getFrontPcbRev	(	ABOUTHANDLE	,
		uint8_t *	major,
		uint8_t *	minor
	)

Get the front hardware pcb revision in the format major.minor (e.g. 1.1).

Supported Platform(s): XA, XS

Parameters

major	The major pcb revision.
minor	The minor pcb revision.

Returns

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

About_getIOExpanderValue()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIOExpanderValue	(	ABOUTHANDLE	,
		uint16_t *	value
	)

Get Value for IO Expander

Supported Platform(s): XA, XS

Parameters

value

IO Expander value.

Returns

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

About_getIsAnybusMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsAnybusMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get Anybus mounting status.

Supported Platform(s): XA, XS

Parameters

mounted

Is Anybus mounted?

Returns

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

Example Usage:

    bool isAnybusMounted;
    err = CrossControl::About_getIsAnybusMounted(pAbout, &isAnybusMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Anybus mounted: " << (isAnybusMounted ? "YES" : "NO") << endl;

About_getIsBTMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsBTMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get BlueTooth module mounting status.

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

Parameters

mounted

Is module mounted?

Returns

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

Example Usage:

    bool isBTMounted;
    err = About_getIsBTMounted(pAbout, &isBTMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "BT mounted: " << (isBTMounted ? "YES" : "NO") << endl;

About_getIsDisplayAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsDisplayAvailable	(	ABOUTHANDLE	,
		bool *	available
	)

Get Display module status. (Some product variants does not have a display)

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

available

Is display available?

Returns

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

Example Usage:

    bool displayAvailable;
    err = About_getIsDisplayAvailable(pAbout, &displayAvailable);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Display available: " << (displayAvailable ? "YES" : "NO") << endl;

About_getIsGPRSMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsGPRSMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get GPRS module mounting status.

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

Parameters

mounted

Is module mounted?

Returns

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

Example Usage:

    bool isGPRSMounted;
    err = About_getIsGPRSMounted(pAbout, &isGPRSMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "GPRS mounted: " << (isGPRSMounted ? "YES" : "NO") << endl;

About_getIsGPSMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsGPSMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get GPS module mounting status.

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

Parameters

mounted

Is module mounted?

Returns

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

Example Usage:

    bool isGPSMounted;
    err = About_getIsGPSMounted(pAbout, &isGPSMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "GPS mounted: " << (isGPSMounted ? "YES" : "NO") << endl;

About_getIsIOExpanderMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsIOExpanderMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get IO Expander mounting status.

Supported Platform(s): XA, XS

Parameters

mounted

Is IO Expander mounted?

Returns

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

Example Usage:

    bool isIOExpanderMounted;
    err = CrossControl::About_getIsIOExpanderMounted(pAbout, &isIOExpanderMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "IOExpander mounted: " << (isIOExpanderMounted ? "YES" : "NO") << endl;

About_getIsPCBBluetoothAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsPCBBluetoothAvailable	(	ABOUTHANDLE	,
		bool *	available
	)

Get PCB mounted bluetooth status. Not to be confused with the bluetooth module mounted on the telematics add on board

Supported Platform(s): VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

available

Is bluetooth available?

Returns

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

Example Usage:

    bool pcbBluetoothAvailable;
    err = About_getIsPCBBluetoothAvailable(pAbout, &pcbBluetoothAvailable);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "PCB Bluetooth available: " << (pcbBluetoothAvailable ? "YES" : "NO") << endl;

About_getIsTouchScreenAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsTouchScreenAvailable	(	ABOUTHANDLE	,
		bool *	available
	)

Get Display TouchScreen status.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

available

Is TouchScreen available?

Returns

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

Example Usage:

    bool touchScreenAvailable;
    err = About_getIsTouchScreenAvailable(pAbout, &touchScreenAvailable);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "TouchScreen available: " << (touchScreenAvailable ? "YES" : "NO") << endl;

About_getIsWLANMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsWLANMounted	(	ABOUTHANDLE	,
		bool *	mounted
	)

Get WLAN module mounting status.

Supported Platform(s): XL, XM, XS, XA, Yukon, V510, V710, V1000, V1200, X1200

Parameters

mounted

Is module mounted?

Returns

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

Example Usage:

    bool isWLANMounted;
    err = About_getIsWLANMounted(pAbout, &isWLANMounted);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "WLAN mounted: " << (isWLANMounted ? "YES" : "NO") << endl;

About_getMainHWversion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainHWversion	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get main hardware version (PCB revision).

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainHWversion(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Main hardware version: " << buffer << endl;

About_getMainManufacturingDate()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainManufacturingDate	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get main manufacturing date.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainManufacturingDate(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Manufacturing date: " << buffer << endl;

About_getMainPCBArt()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainPCBArt	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	length
	)

Get main PCB article number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
length	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainPCBArt(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Main PCB article number: " << buffer << endl;

About_getMainPCBSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainPCBSerial	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get main PCB serial number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainPCBSerial(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Main PCB serial: " << buffer << endl;

About_getMainProdArtNr()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainProdArtNr	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get main product article number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainProdArtNr(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Main product article number: " << buffer << endl;

About_getMainProdRev()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainProdRev	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get main product revision.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getMainProdRev(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Main product revision: " << buffer << endl;

About_getNrOfAnalogInputs()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfAnalogInputs	(	ABOUTHANDLE	,
		int32_t *	numanalogins
	)

Get number of external analog inputs.

Supported Platform(s): VI2

Parameters

numanalogins

Number of external analog inputs.

Returns

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

Example Usage:

About_getNrOfButtons()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfButtons	(	ABOUTHANDLE	,
		int32_t *	numbuttons
	)

Get number of configurable buttons.

Supported Platform(s): VC, VA, VS, VI2, V510, V710, V1000, V1200, Yukon

Parameters

numbuttons

Number of configurable buttons.

Returns

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

Example Usage:

    int nrOfButtons;
    err = About_getNrOfButtons(pAbout, &nrOfButtons);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of configurable buttons: " << (int)nrOfButtons << endl;
    else if (CrossControl::ERR_NOT_SUPPORTED == err)
        cout << "About_getNrOfButtons: Not supported" << endl;

About_getNrOfCANConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfCANConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of CAN connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

NrOfConnections

Returns the number of connections.

Returns

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

Example Usage:

    unsigned char nrOfCANConnections;
    err = About_getNrOfCANConnections(pAbout, &nrOfCANConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of CAN connections: " << (int)nrOfCANConnections << endl;

About_getNrOfCfgInConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfCfgInConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of configurable input connections present.

Supported Platform(s): VC, VA, VS, VI2

Parameters

NrOfConnections

Returns the number of inputs.

Returns

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

Example Usage:

    unsigned char nrOfCfgIn;
    err = About_getNrOfCfgInConnections(pAbout, &nrOfCfgIn);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of configurable inputs: " << (int)nrOfCfgIn << endl;
    else if (CrossControl::ERR_NOT_SUPPORTED == err)
        cout << "About_getNrOfCfgInConnections: Not supported" << endl;

About_getNrOfDigIOConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfDigIOConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of digital I/O connections present.

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

Parameters

NrOfConnections

Returns the number of input or input/output connections.

Returns

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

Example Usage:

    unsigned char nrOfDigIOConnections;
    err = About_getNrOfDigIOConnections(pAbout, &nrOfDigIOConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of digital I/O connections: " << (int)nrOfDigIOConnections << endl;

About_getNrOfETHConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfETHConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of Ethernet connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

NrOfConnections

Returns the number of connections.

Returns

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

Example Usage:

    unsigned char nrOfEthConnections;
    err = About_getNrOfETHConnections(pAbout, &nrOfEthConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of ethernet connections: " << (int)nrOfEthConnections << endl;

About_getNrOfPWMOutConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfPWMOutConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of PWM Output connections present.

Supported Platform(s): VC, VA, VI2

Parameters

NrOfConnections

Returns the number of outputs.

Returns

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

Example Usage:

    unsigned char nrOfPwmOut;
    err = About_getNrOfPWMOutConnections(pAbout, &nrOfPwmOut);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of PWM outputs: " << (int)nrOfPwmOut << endl;
    else if (CrossControl::ERR_NOT_SUPPORTED == err)
        cout << "About_getNrOfPWMOutConnections: Not supported" << endl;

About_getNrOfSerialConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfSerialConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of serial port (RS232) connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

NrOfConnections

Returns the number of connections.

Returns

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

Example Usage:

    unsigned char nrOfSerialConnections;
    err = About_getNrOfSerialConnections(pAbout, &nrOfSerialConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of serial connections: " << (int)nrOfSerialConnections << endl;

About_getNrOfUSBConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfUSBConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of USB connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

NrOfConnections

Returns the number of connections.

Returns

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

Example Usage:

    unsigned char nrOfUSBConnections;
    err = About_getNrOfUSBConnections(pAbout, &nrOfUSBConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of USB connections: " << (int)nrOfUSBConnections << endl;

About_getNrOfVideoConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfVideoConnections	(	ABOUTHANDLE	,
		uint8_t *	NrOfConnections
	)

Get number of Video connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

NrOfConnections

Returns the number of connections.

Returns

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

Example Usage:

    unsigned char nrOfVideoConnections;
    err = About_getNrOfVideoConnections(pAbout, &nrOfVideoConnections);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Nr of video connections: " << (int)nrOfVideoConnections << endl;

About_getUnitSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getUnitSerial	(	ABOUTHANDLE	,
		char_t *	buff,
		int32_t	len
	)

Get unit serial number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

buff	Text output buffer.
len	Maximum length of the output buffer. If the actual length of the data is greater, an error will be returned.

Returns

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

Example Usage:

    err = About_getUnitSerial(pAbout, buffer, buffer_len);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "Unit serial: " << buffer << endl;

About_getUserEepromData()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getUserEepromData	(	ABOUTHANDLE	,
		char_t *	buff,
		uint16_t	length
	)

Get User Eeprom data. The user eeprom holds 4096 bytes of data which are fully accessible. Data is always read from position 0.

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

Parameters

buff	data buffer.
length	data buffer length or number of data bytes to read.

Returns

error status. 0 = ERR_SUCCESS, otherwise error code.

About_hasOsBooted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_hasOsBooted	(	ABOUTHANDLE	,
		bool *	bootComplete
	)

Get the status of the OS boot process. In Linux, drivers may be delay-loaded at start-up. If the application is started early in the boot-process, this function can be used to determine when full functionality can be obtained from the API/drivers.

Supported Platform(s): XA, XS, VC, VA, VI2, VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters

bootComplete

Is the OS fully booted?

Returns

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

Example Usage:

    bool isBootComplete;
    err = CrossControl::About_hasOsBooted(pAbout, &isBootComplete);
    if (CrossControl::ERR_SUCCESS == err)
        cout << "System bootup complete: " << (isBootComplete ? "YES" : "NO") << endl;

About_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::About_release

(

ABOUTHANDLE

)

Delete the About object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns

-

Example Usage:

    ABOUTHANDLE pAbout = ::GetAbout();
    assert(pAbout);
 
    list_about_information(pAbout);
 
    About_release(pAbout);

About_setUserEepromData()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_setUserEepromData	(	ABOUTHANDLE	,
		uint16_t	startpos,
		const char_t *	buff,
		uint16_t	length
	)

Set User Eeprom data. The user eeprom holds 4096 bytes of data which are fully accessible.

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

Parameters

startpos	eeprom write start position.
buff	data buffer.
length	buffer length to write.

Returns

error status. 0 = ERR_SUCCESS, otherwise error code.

GetAbout()

EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetAbout

(

void

)

Factory function that creates instances of the About object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns

ABOUTHANDLE to an allocated About object. The returned handle needs to be deallocated using the About_release(ABOUTHANDLE) method when it's no longer needed.

Returns NULL if it fails to allocate memory.

Example Usage:

    ABOUTHANDLE pAbout = ::GetAbout();
    assert(pAbout);
 
    list_about_information(pAbout);
 
    About_release(pAbout);