CTransformFilter::BeginFlush

  • Artigo
 
Microsoft DirectShow 9.0

CTransformFilter::BeginFlush

The BeginFlush method begins a flush operation.

Syntax

  virtual HRESULT BeginFlush(void);

Return Value

Returns S_OK or another HRESULT value.

Remarks

At the start of a flush operation, the input pin's CTransformInputPin::BeginFlush method calls this method. This method passes the BeginFlush call downstream.

If the derived class uses a worker thread to deliver samples, it should discard any queued data during a flush operation. That can be done either in the BeginFlush method, or in the EndFlush method. However, note that calls to BeginFlush are not synchronized with the streaming thread. If the BeginFlush method discards the queued data, the filter must be careful not to process any more data between the BeginFlush and EndFlush calls. For more information, see Data Flow for Filter Developers.

Requirements

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

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

See Also