ISensorDriver::OnGetSupportedProperties method

The ISensorDriver::OnGetSupportedProperties method retrieves the list of properties that the specified sensor provides.

Syntax

HRESULT OnGetSupportedProperties(
  LPWSTR                       pwszSensorID,
  IPortableDeviceKeyCollection **ppSupportedProperties
);

Parameters

pwszSensorID

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

ppSupportedProperties

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

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

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

Each IPortableDeviceKeyCollection object returned in this collection must contain PROPERTYKEYs for the required properties, as described in the Sensor Properties reference section.

IPortableDeviceKeyCollection is documented in Windows Portable Devices.

Requirements

   
Target Platform Windows
Header sensorsclassextension.h
Library SensorsClassExtension.lib

See Also

ISensorDriver