ISensorManager::GetSensorsByCategory 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 a collection containing all sensors associated with the specified category.

Syntax

HRESULT GetSensorsByCategory(
  [in]  REFSENSOR_CATEGORY_ID sensorCategory,
  [out] ISensorCollection     **ppSensorsFound
);

Parameters

[in] sensorCategory

ID of the sensor category to retrieve.

[out] ppSensorsFound

Address of an ISensorCollection interface pointer that receives a pointer to the sensor collection requested.

Return value

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

Return code	Description
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)	No sensors are available for the specified category.
S_OK	The method succeeded.
E_POINTER	NULL was passed in for ppSensorsFound.

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

ISensorManager

Retrieving a Sensor Object