Edit

ISensor::GetProperty method (sensorsapi.h)

  • Article

Retrieves a property value.

Syntax

HRESULT GetProperty(
  [in]  REFPROPERTYKEY key,
  [out] PROPVARIANT    *pProperty
);

Parameters

[in] key

REFPROPERTYKEY specifying the property value to be retrieved.

[out] pProperty

PROPVARIANT pointer that receives the property value.

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.
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
The sensor does not support the specified property. The value provided through pProperty is VT_NULL.
E_POINTER
 NULL was passed in for pProperty.

Remarks

To retrieve multiple property values as a collection, call ISensor::GetProperties.

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