IRobot::GetEventNameFromID

Finds the name of an event given its ID

HRESULT IRobot::GetEventNameFromID (
     EventID id,
     TCHAR ** name
)

Parameters
id
ID of the event to look for
name
Returns the name of the event

Return Values
ValueMeaning
S_OKEvent name retrieved successfully
E_FAILCannot find the specified event
E_OUTOFMEMORYCannot allocate name buffer

Remarks
The caller should call CoTaskMemFree to deallocate the name buffer.
If the specified event is part of an event/anti-event pair, then depending on whether the specified ID matches the event or the anti-event, the name will be prefixed with a plus (+) or minus (-) respectively. Otherwise the name is returned as is.