Share via

CBaseInputPin::BeginFlush

  • Article
 
Microsoft DirectShow 9.0

CBaseInputPin::BeginFlush

The CBaseInputPin method begins a flush operation. This method implements the IPin::BeginFlush method.

Syntax

  HRESULT BeginFlush(void);

Return Value

Returns S_OK.

Remarks

This method sets the CBaseInputPin::m_bFlushing flag to TRUE, which causes the CBaseInputPin::Receive method to reject any more samples.

The derived class must override this method and perform the following steps:

  1. Call the IPin::BeginFlush method on downstream input pins. If the pin has not yet delivered any media samples downstream, you can skip this step. If your output pins derive from the CBaseOutputPin class, you can call the CBaseOutputPin::DeliverBeginFlush method.
  2. Call the base class method.
  3. Begin discarding queued data.
  4. Return from any blocked calls to the Receive method.

Requirements

**  Header:** Declared in Amfilter.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also