ISensorEvents::OnEvent method (sensorsapi.h)

Provides custom event notifications.

Syntax

HRESULT OnEvent(
  [in] ISensor               *pSensor,
  [in] REFGUID               eventID,
  [in] IPortableDeviceValues *pEventData
);

Parameters

[in] pSensor

Pointer to the ISensor interface that represents the sensor that raised the event.

[in] eventID

REFGUID that identifies the event.

[in] pEventData

Pointer to the IPortableDeviceValues interface that contains the event data.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This callback method receives custom event notifications. Custom events are defined by sensor providers. Platform-defined event IDs are defined in Sensors.h.

To receive new data from a sensor, use the OnDataUpdated Method.

Examples

For an example of how to receive sensor events, see Using Sensor API Events.

Requirements

See also

ISensorEvents