CPullPin.Inactive 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 Inactive method shuts down the worker thread that pulls data from the output pin. This method also decommits the allocator.

Syntax

HRESULT Inactive();

Parameters

This method has no parameters.

Return value

Returns S_OK.

Remarks

Call this method when the owning filter becomes inactive. (If your input pin derives from CBasePin, override the CBasePin::Inactive method.)

Requirements

Requirement Value
Header
Pullpin.h
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CPullPin Class