IMediaEvent::CancelDefaultHandling method (control.h)

Article
07/27/2023

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The CancelDefaultHandling method cancels the Filter Graph Manager's default handling for a specified event. The event notification is passed to the application.

Syntax

HRESULT CancelDefaultHandling(
  long lEvCode
);

Parameters

lEvCode

Event code for which to cancel default handling.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code	Description
S_OK	Success.
E_INVALIDARG	No default handling for this event.

Remarks

To restore the default handling for an event, call the IMediaEvent::RestoreDefaultHandling method with the event code.

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	control.h (include Dshow.h)
Library	Strmiids.lib