IPin::ConnectedTo method (strmif.h)

Article
07/27/2023

[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 ConnectedTo method retrieves a pointer to the connected pin, if any.

Syntax

HRESULT ConnectedTo(
  [out] IPin **pPin
);

Parameters

[out] pPin

Receives a pointer to the IPin interface of the other pin. The caller must release the interface. This parameter cannot be NULL.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	Success.
E_POINTER	NULL pointer argument.
VFW_E_NOT_CONNECTED	Pin is not connected.

Remarks

If the method succeeds, the IPin interface that it returns has an outstanding reference count. Be sure to release it when you are done.

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