ISensor::GetState 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.

Retrieves the current operational state of the sensor.

Syntax

HRESULT GetState(
  [out] SensorState *pState
);

Parameters

[out] pState

Address of a SensorState variable that receives the current state.

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_UNEXPECTED	The sensor driver did not provide a state value. The value provided through pState is not valid.
E_POINTER	NULL was passed in for pState.

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