Skip to content

Latest commit

 

History

History
183 lines (152 loc) · 4.51 KB

nf-mfobjects-imfmediaeventgenerator-getevent.md

File metadata and controls

183 lines (152 loc) · 4.51 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mfobjects.IMFMediaEventGenerator.GetEvent
IMFMediaEventGenerator::GetEvent (mfobjects.h)
Retrieves the next event in the queue. This method is synchronous.
0
GetEvent
GetEvent method [Media Foundation]
GetEvent method [Media Foundation]
IMFMediaEventGenerator interface
IMFMediaEventGenerator interface [Media Foundation]
GetEvent method
IMFMediaEventGenerator.GetEvent
IMFMediaEventGenerator::GetEvent
MF_EVENT_FLAG_NO_WAIT
e78464b5-ec6b-4739-a135-352fa297916a
mf.imfmediaeventgenerator_getevent
mfobjects/IMFMediaEventGenerator::GetEvent
mf\imfmediaeventgenerator_getevent.htm
mf
e78464b5-ec6b-4739-a135-352fa297916a
12/05/2018
0, GetEvent, GetEvent method [Media Foundation], GetEvent method [Media Foundation],IMFMediaEventGenerator interface, IMFMediaEventGenerator interface [Media Foundation],GetEvent method, IMFMediaEventGenerator.GetEvent, IMFMediaEventGenerator::GetEvent, MF_EVENT_FLAG_NO_WAIT, e78464b5-ec6b-4739-a135-352fa297916a, mf.imfmediaeventgenerator_getevent, mfobjects/IMFMediaEventGenerator::GetEvent
mfobjects.h
Mfidl.h
Windows
Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 [desktop apps \| UWP apps]
Mfuuid.lib
Windows
19H1
IMFMediaEventGenerator::GetEvent
mfobjects/IMFMediaEventGenerator::GetEvent
c++
APIRef
kbSyntax
COM
mfuuid.lib
mfuuid.dll
IMFMediaEventGenerator.GetEvent

IMFMediaEventGenerator::GetEvent

-description

Retrieves the next event in the queue. This method is synchronous.

-parameters

-param dwFlags [in]

Specifies one of the following values.

Value Meaning
0
 The method blocks until the event generator queues an event.
MF_EVENT_FLAG_NO_WAIT
 The method returns immediately.

-param ppEvent [out]

Receives a pointer to the IMFMediaEvent interface. The caller must release the interface.

-returns

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
E_INVALIDARG
 NULL pointer argument.
MF_E_MULTIPLE_SUBSCRIBERS
 There is a pending request.
MF_E_NO_EVENTS_AVAILABLE
 There are no events in the queue.
MF_E_SHUTDOWN
 The object was shut down.

-remarks

This method executes synchronously.

If the queue already contains an event, the method returns S_OK immediately. If the queue does not contain an event, the behavior depends on the value of dwFlags:

  • If dwFlags is 0, the method blocks indefinitely until a new event is queued, or until the event generator is shut down.
  • If dwFlags is MF_EVENT_FLAG_NO_WAIT, the method fails immediately with the return code MF_E_NO_EVENTS_AVAILABLE.
This method returns MF_E_MULTIPLE_SUBSCRIBERS if you previously called IMFMediaEventGenerator::BeginGetEvent and have not yet called IMFMediaEventGenerator::EndGetEvent.

-see-also

IMFMediaEventGenerator

Media Event Generators