IVIO_EnumMaintenanceEntry::Set
This method sets the value of the current item referenced by the enumerator.
Syntax
HRESULT IVIO_EnumMaintenanceEntry::Set ( LPVARIANT pValue);
Parameters
- pValue
- [in] Pointer to the VARIANT that contains the new value.
Use a VT_BSTR to set the following value. A VT_BSTR is a 32-bit character string.
- VIOMAINTENTRY_NAME
- Specifies the name of the maintenance item.
Use a VT_UI4 to set the following values. A VT_UI4 is an unsigned long integer.
- VIOMAINTENTRY_LOW_INTERVAL
- Specifies the shortest maintenance interval, for example, 4,800 km (3,000 miles) for an oil change.
- VIOMAINTENTRY_HIGH_INTERVAL
- Specifies the longest maintenance interval, for example, 12,000 km (7,500 miles) for an oil change.
- VIOMAINTENTRY_INTERVAL_TYPE
- Specifies the type of interval, for example, time or mileage. It is one of the following values:
VIOMAINTINTERVALTYPE_CALENDAR_TIME |
VIOMAINTINTERVALTYPE_MILEAGE |
VIOMAINTINTERVALTYPE_RUNNING_TIME |
- VIOMAINTENTRY_INTERVAL_UNITS
- Specifies the units used in the interval. It is one of the following values:
VIOMAINTINTERVALUNITS_DAYS |
VIOMAINTINTERVALUNITS_HOURS |
VIOMAINTINTERVALUNITS_KILOMETERS |
VIOMAINTINTERVALUNITS_MILES |
VIOMAINTINTERVALUNITS_MONTHS |
- VIOMAINTENTRY_SECONDARY_INTERVAL
- Specifies the secondary interval to use, for example, three months for an oil change. An application looks for either the low interval or the secondary interval to elapse in order to give a maintenance warning.
- VIOMAINTENTRY_SECONDARY_INTERVAL_TYPE
- Specifies the type of secondary interval. It can be one of the values listed for VIOMAINTENTRY_INTERVAL_TYPE.
- VIOMAINTENTRY_SECONDARY_INTERVAL_UNITS
- Specifies the unites used for the secondary interval. It can be one of the values listed for VIOMAINTENTRY_INTERVAL_UNITS.
Return Values
One of the values described in the following table is returned.
Value
|
Description
|
S_OK |
The value of the item currently referenced by the enumerator was set successfully. |
S_FALSE |
The enumerator is not positioned on a valid item. |
E_OUTOFMEMORY |
The application is out of memory. |
E_POINTER |
The pointer referenced by pValue is invalid. |