CBasePin::BreakConnect

  • Article
 
Microsoft DirectShow 9.0

CBasePin::BreakConnect

The BreakConnect method releases the pin from a connection.

Syntax

  virtual HRESULT BreakConnect(void);

Return Value

Returns S_OK.

Remarks

This method is called during pin disconnection by the CBasePin::Disconnect method. It is also called during a connection attempt if the CBasePin::CheckConnect method fails.

This method must free any resources that were obtained by the CheckConnect method. For example, if CheckConnect allocates memory, BreakConnect should free the memory. If CheckConnect queries the connecting pin for an interface, BreakConnect should free the interface.

Note that BreakConnect can be called without a corresponding call to CompleteConnect. Therefore, you cannot assume that CompleteConnect has been called previously.

Requirements

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

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

See Also