Purpose

Reads a single scaled value from a named Characteristic on the ECU which is identified by the ECU Reference handle. Format

mcTypeStatus mcCharacteristicReadSingleValue(
mcTypeTaskRef ECURefNum,
char *CharacteristicName,
f64 *Value,
u32 X,
u32 Y);

Input

ECURefNum

ECURefNum is the task reference which links to the selected ECU. This reference is originally returned from .

CharacteristicName

CharacteristicName is the name of the Characteristic defined in the A2L database file.

X

X is the horizontal index if the Characteristic consists of 1 or 2 dimensions.

Y

Y is the vertical index if the Characteristic consists of 2 dimensions. Output

Value

Returns a single value from the selected Characteristic.

Return Value

The return value indicates the status of the function call as a signed 32-bit integer. Zero means the function executed successfully. A negative value specifies an error, which means the function did not perform the expected behavior. A positive value specifies a warning, which means the function performed as expected, but a condition arose that may require attention.

Use the mcStatusToString function of the ECU M&C API to obtain a descriptive string for the return value.

Description

mcCharacteristicReadSingleValue reads a scaled value from a named Characteristic on the ECU which is identified by the ECU Reference handle. The value to be read is identified by the X and Y indices.

If the Characteristic array is 0-dimensional, X and Y can be set to 0.

If the Characteristic array is 1-dimensional, Y can be set to 0.