CPullPin.Active 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 Active method creates a worker thread that pulls data from the output pin. This method also commits the allocator.

Syntax

HRESULT Active();

Parameters

This method has no parameters.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
Success.
E_UNEXPECTED
The pin connection was not established correctly.
E_FAIL
Could not create the thread, or the thread already exists.

Remarks

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

Before calling this method, call the CPullPin::Connect method to establish the connection with the output pin.

Requirements

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

See also

CPullPin Class