CBasePin.CheckConnect 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 CheckConnect method determines whether a pin connection is suitable.
Syntax
virtual HRESULT CheckConnect(
IPin *pPin
);
Parameters
-
pPin
-
Pointer to the other pin's IPin interface.
Return value
Returns one of the HRESULT values shown in the following table.
| Return code | Description |
|---|---|
|
Success. |
|
Pin directions are not compatible. |
Remarks
This method is called on both pins at the start of the connection process. The connecting pin calls it from within the CBasePin::Connect method, and the receiving pin calls it from within the CBasePin::ReceiveConnection method.
Use this method to determine whether the pin specified by the pPin parameter is suitable for a connection. The base class returns an error if both pins have the same direction (both input, or both output). Derived classes can override this method to verify other features in the pin. For example, the CBaseOutputPin class queries the input pin for its IMemInputPin interface.
If this method fails, the connection fails and the pin calls the CBasePin::BreakConnect method. Use BreakConnect to free any resources obtained in CheckConnect. For example, if CheckConnect calls the QueryInterface method, BreakConnect must release the interface.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|