ISensorDriver::OnGetSupportedDataFields method

The ISensorDriver::OnGetSupportedDataFields method retrieves the list of data fields that the specified sensor can provide.

Syntax

HRESULT OnGetSupportedDataFields(
  LPWSTR                       pwszSensorID,
  IPortableDeviceKeyCollection **ppSupportedDataFields
);

Parameters

pwszSensorID

LPWSTR that contains the ID for the sensor from which the client application is requesting the data fields list.

ppSupportedDataFields

Address of an IPortableDeviceKeyCollection pointer that receives the list of PROPERTYKEY values that represent the supported data fields.

Return Value

If the operation succeeds, this method returns S_OK. Otherwise, this method returns one of the error codes that are defined in Winerror.h.

Remarks

Data fields contain sensor-generated data, as opposed to properties, which describe the sensor device. Platform-defined data fields are defined in sensors.h.

All drivers must support SENSOR_DATA_TYPE_TIMESTAMP as a required data field.

IPortableDeviceKeyCollection is documented in Windows Portable Devices.

Requirements

   
Target Platform Windows
Header sensorsclassextension.h
Library SensorsClassExtension.lib

See Also

ISensorDriver