IPin::Disconnect method (strmif.h)

[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 Disconnect method breaks the current pin connection.

The Filter Graph Manager calls this method when it disconnects two filters. Applications and filters should not call this method. Instead, call the IFilterGraph::Disconnect method on the Filter Graph Manager.

Syntax

HRESULT Disconnect();

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_FALSE	The pin was not connected.
S_OK	Success.
VFW_E_NOT_STOPPED	The filter is active.

Remarks

This method fails if the filter is paused or running. If the pin supports the IPinConnection interface, call IPinConnection::DynamicDisconnect to disconnect the pin when the filter is paused or running.

This method does not disconnect the other pin in the pin connection.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib

See also

Data Flow in the Filter Graph

Error and Success Codes

IPin Interface