CCmdQueue::GetDueCommand

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.

See Also

• CCmdQueue Class