IMMNotificationClient::OnPropertyValueChanged method (mmdeviceapi.h)

Article
10/13/2021

The OnPropertyValueChanged method indicates that the value of a property belonging to an audio endpoint device has changed.

Syntax

HRESULT OnPropertyValueChanged(
  [in] LPCWSTR           pwstrDeviceId,
  [in] const PROPERTYKEY key
);

Parameters

[in] pwstrDeviceId

Pointer to the endpoint ID string that identifies the audio endpoint device. This parameter points to a null-terminated, wide-character string that contains the endpoint ID. The string remains valid for the duration of the call.

[in] key

A PROPERTYKEY structure that specifies the property. The structure contains the property-set GUID and an index identifying a property within the set. The structure is passed by value. It remains valid for the duration of the call. For more information about PROPERTYKEY, see the Windows SDK documentation.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

A call to the IPropertyStore::SetValue method that successfully changes the value of a property of an audio endpoint device generates a call to OnPropertyValueChanged. For more information about IPropertyStore::SetValue, see the Windows SDK documentation.

A client can use the key parameter to retrieve the new property value. For a code example that uses a property key to retrieve a property value from the property store of an endpoint device, see Device Properties.

For a code example that implements the OnPropertyValueChanged method, see Device Events.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	mmdeviceapi.h