Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

Retrieves the pin with the specified identifier.

Syntax 

HRESULT FindPin(
  LPCWSTR 
Id,
  IPin** 
ppPin
);

Parameters

Id

Identifier of the pin.

ppPin

Pointer to the IPininterface for this pin after the filter has been restored.

Return Value

The default implementation by this member function returns S_OK if the pin name was found or VFW_E_NOT_FOUNDotherwise.

Remarks

This member function provides a base class definition of the IBaseFilter::FindPinmethod that, along with the IPin::QueryIdmethod, is used to implement persistent filter graphs.

A filter must be able to translate the IPininterface pointers to its pins into identifiers that can be saved along with the configuration of the filter graph. It does this by using the IPin::QueryIdmethod. It must then be able to convert those identifiers back into IPininterface pointers when the filter and its connections are restored as part of a persistent filter graph. This is accomplished using the IBaseFilter::FindPinmethod.

By default, the base classes use the pin name in the m_pNamedata member, so implementing this member function in your derived filter class is not normally required.

The ppPinparameter is set to NULL if the identifier cannot be matched.

Requirements

Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment