Edit

Share via


ISensor::SupportsDataField method (sensorsapi.h)

Important

Use the UWP Sensor API instead.

The COM-based Sensor API is deprecated and should not be used in new applications. No additional features or enhancements are planned, and support will be limited.

Indicates whether the sensor supports the specified data field.

Syntax

HRESULT SupportsDataField(
  [in]  REFPROPERTYKEY key,
  [out] VARIANT_BOOL   *pIsSupported
);

Parameters

[in] key

REFPROPERTYKEY value specifying the data field to search for.

[out] pIsSupported

Address of a VARIANT_BOOL that receives a value indicating whether the sensor supports the data field.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
E_POINTER
NULL was passed in for pIsSupported.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header sensorsapi.h
Library Sensorsapi.lib
DLL Sensorsapi.dll

See also

ISensor