IOleControl::OnAmbientPropertyChange method (ocidl.h)

Article
02/22/2024

Informs a control that one or more of the container's ambient properties has changed.

Syntax

HRESULT OnAmbientPropertyChange(
  [in] DISPID dispID
);

Parameters

[in] dispID

The dispatch identifier of the ambient property that changed. If this parameter is DISPID_UNKNOWN, it indicates that multiple properties changed. In this case, the control should check all the ambient properties of interest to obtain their current values.

Return value

This method returns S_OK in all cases.

Remarks

Notes to Implementers

S_OK is returned in all cases even when the control does not support ambient properties or some other failure has occurred. The caller sending the notification cannot attempt to use an error code (such as E_NOTIMPL) to determine whether to send the notification in the future. Such semantics are not part of this interface.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ocidl.h

Share via