Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 2.46 KB

cbasepin-inactive.md

File metadata and controls

77 lines (44 loc) · 2.46 KB
description ms.assetid title ms.topic ms.date topic_type api_name api_type api_location ms.custom
CBasePin.Inactive method - The Inactive method notifies the pin that the filter is no longer active.
71847578-2271-4243-87c4-9f14b33f770c
CBasePin.Inactive method (Amfilter.h)
reference
4/26/2023
APIRef
kbSyntax
CBasePin.Inactive
COM
Strmbase.lib
Strmbase.dll
Strmbasd.lib
Strmbasd.dll
UpdateFrequency5

CBasePin.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 notifies the pin that the filter is no longer active.

Syntax

virtual HRESULT Inactive();

Parameters

This method has no parameters.

Return value

Returns S_OK.

Remarks

When the filter stops, the CBaseFilter class calls this method on all of the filter's connected pins.

This method does nothing in the base class. Derived classes should override this method to free any resources obtained by the CBasePin::Active method; for example, to decommit the pin's allocators.

The filter graph manager's internal state is not updated until after this method returns, so do not test the state from this method.

Requirements

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

See also

CBasePin Class