 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. |
Retrieves the pin with the specified identifier.
HRESULT FindPin( LPCWSTR Id , IPin ** ppPin );
Parameters
- Id
- [in] Identifier of the pin.
- ppPin
- [out] Pointer to the
IPininterface for this pin
after the filter has been restored. The returned
IPinpointer has been reference counted. The caller should
use the
Releasemethod on the
pointer when finished with it.
Return Values
Returns an HRESULTvalue that depends on the implementation. HRESULTcan be one of the following standard constants, or other values not listed:
Value Descripton E_FAIL Failure. E_POINTER Null pointer argument. E_INVALIDARG Invalid argument. E_NOTIMPL Method isn't supported. S_OK or NOERROR Success. Remarks
This method, 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 by using the IBaseFilter::FindPinmethod.
The ppPinparameter is set to NULL if the identifier cannot be matched.