IVIO_EnumMetrics::Seek

This method searches for a metrics item identifier in the vehicle metrics collection.

Syntax

HRESULT IVIO_EnumMetrics::Seek ( DWORD nItemId);

Parameters

nItemId
[in] Identifier of the vehicle metrics collection member to search for. 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

S_OK indicates that the vehicle metrics item was retrieved successfully. The enumerator is set to the position of the specified metric. E_FAIL indicates that the application is unable to find the specified item identifier. The enumerator’s position is unchanged.

Remarks

Use the IVIO_EnumMetrics::Next and IVIO_EnumMetrics::Set methods to read and write metrics data.