IMediaEvent::FreeEventParams method (control.h)

Article
02/22/2024

[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 FreeEventParams method frees resources associated with the parameters of an event.

Syntax

HRESULT FreeEventParams(
  [in] long     lEvCode,
  [in] LONG_PTR lParam1,
  [in] LONG_PTR lParam2
);

Parameters

[in] lEvCode

Event code.

[in] lParam1

First event parameter.

[in] lParam2

Second event parameter.

Return value

Returns S_OK.

Remarks

After you call the IMediaEvent::GetEvent method to retrieve an event notification, you must call FreeEventParams. This method frees any resources that were allocated for the event parameters. Pass in the same variables used for the GetEvent call.

Examples


hr = pEvent->GetEvent(&evCode, &param1, &param2, 0);
// Handle the event (not shown). 
hr = pEvent->FreeEventParams(evCode, param1, param2);

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

Share via