CCmdQueue.GetDueCommand method
[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 GetDueCommand method retrieves a pointer to the next command that is due.
Syntax
virtual HRESULT GetDueCommand(
CDeferredCommand **ppCmd,
long msTimeout
);
Parameters
-
ppCmd
-
Address of a pointer to the deferred command.
-
msTimeout
-
Amount of time to wait before carrying out the time-out.
Return value
Returns E_ABORT if a time-out occurs. Returns S_OK if successful; otherwise, returns an error. Returns an object that has been incremented using IUnknown::AddRef.
Remarks
This member function blocks until a pending command is due. The member function blocks for the amount of time, in milliseconds, specified in the msTimeout parameter. Stream-time commands become due only between the CCmdQueue::Run and CCmdQueue::EndRun member functions. The command remains queued until run or canceled.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|