CBasePin.DisconnectInternal 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 DisconnectInternal method breaks the current pin connection.

Syntax

HRESULT DisconnectInternal();

Parameters

This method has no parameters.

Return value

Returns an HRESULT value. Possible values include those in the following table.

Return code Description
S_FALSE
The pin was not connected.
S_OK
Success.
VFW_E_NOT_STOPPED
The filter is active and the pin does not support dynamic reconnection.

Remarks

The CBasePin::Disconnect method delegates the disconnect process to this method. This method calls the CBasePin::BreakConnect method. It also releases the reference count on the other pin, which is held by the CBasePin::m_Connected member variable.

Requirements

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

See also

CBasePin Class