IPin::EndFlush method (strmif.h)

[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 EndFlush method ends a flush operation.

Applications should not call this method. This method is called by other filters, to flush data from the graph.

Syntax

HRESULT EndFlush();

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	Success.
E_UNEXPECTED	The pin is an output pin.

Remarks

Call this method only on input pins. Output pins return E_UNEXPECTED.

When this method is called, the filter performs the following actions:

1. Waits for all queued samples to be discarded.
2. Frees any buffered data, including any pending end-of-stream notifications.
3. Clears any pending EC_COMPLETE notifications.
4. Calls EndFlush downstream.

When the method returns, the pin can accept new samples.

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

See also

Data Flow in the Filter Graph

Error and Success Codes

IPin Interface