CSource.RemovePin 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 RemovePin method removes a specified pin from the filter. The method does not delete the pin.

Syntax

HRESULT RemovePin(
   CSourceStream *pStream
);

Parameters

pStream

Pointer to the CSourceStream object that implements the pin.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_OK
Success.
S_FALSE
The filter does not contain this pin.

Remarks

The destructor method calls this method, to remove the output pin from the filter.

Requirements

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

See also

CSource Class