CBasePin.CompleteConnect method

[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 CompleteConnect method completes a connection to another pin.

Syntax

virtual HRESULT CompleteConnect(
   IPin *pReceivePin
);

Parameters

pReceivePin

Pointer to the other pin's IPin interface.

Return value

Returns S_OK.

Remarks

This method is called on both pins at the end of the connection process. The connecting pin calls it from within the CBasePin::Connect method, and the receiving pin calls it from within the CBasePin::ReceiveConnection method.

In the base class, this method simply returns S_OK. If a derived class has any requirements for completing a connection, it should override this method. For example, the CBaseOutputPin class uses this method to decide the memory allocator.

If this method fails, the overall connection attempt also fails, and the pin disconnects from the receiving pin.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBasePin Class