IOleControl::FreezeEvents method (ocidl.h)

Article
02/22/2024

Indicates whether the container is ignoring or accepting events from the control.

Syntax

HRESULT FreezeEvents(
  [in] BOOL bFreeze
);

Parameters

[in] bFreeze

Indicates whether the container will ignore (TRUE) or now process (FALSE) events from the control.

Return value

This method returns S_OK in all cases.

Remarks

The control is not required to stop sending events when bFreeze is TRUE. However, the container is not going to process them in this case. If a control depends on the container's processing -- as with request events that return information from the container -- the control must either discard the event or queue the event to send later when bFreeze is FALSE.

Notes to Implementers

As with IOleControl::OnAmbientPropertyChange, S_OK is returned in all cases in order to prevent a container from making assumptions about a control's behavior based on return values.

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