IVIO_EnumMetrics::Add

This method adds a new entry in the vehicle metrics collection. The new entry identifier matches the value of nItemId.

Syntax

HRESULT IVIO_EnumMetrics::Add ( DWORD nItemId);

Parameters

nItemId
[in] Identifier of the vehicle metrics collection member to add. It is one of the following values:
VIOVEHICLEMETRIC_CYLINDERCOUNT
VIOVEHICLEMETRIC_DISPLACEMENT
VIOVEHICLEMETRIC_FUELDELIVERY
VIOVEHICLEMETRIC_FUELTYPE
VIOVEHICLEMETRIC_MAKE
VIOVEHICLEMETRIC_MANUFACTURER
VIOVEHICLEMETRIC_MODEL
VIOVEHICLEMETRIC_TRANSMISSION
VIOVEHICLEMETRIC_TRANSMISSION_GEARS
VIOVEHICLEMETRIC_VIN
VIOVEHICLEMETRIC_YEAR

Return Values

One of the values described in the following table is returned.

Value
Description
S_OK The vehicle item was added successfully. The enumerator is set to the position of the new metric.
S_FALSE The item is already in the enumeration list. The enumeration position is unchanged.
E_FAIL The application is unable to add the item to the enumeration list.

Remarks

The new entry identifier must match the metrics item identifier in nItemId.

Call the IVIO_EnumMetrics::Set method after calling this method to set an initial value for the new metric item.