LoadIFilterFromStreamEx Method

  • Article

The LoadIFilterFromStreamEx method of the IFilterRegistration interface retrieves the best-suited IFilter for the specified data source that is available in an IStream object.

Parameters

pStm   [in] A pointer to an IStream object that contains the class ID of the data source type to be filtered.

PFilteredSource   [in] A pointer to a FILTERED_DATA_SOURCE structure that contains the IFilter to retrieve the information for.

pUnkOuter   [in] A pointer to the outer IUnknown object for the filter to be returned.

fUseDefault   [in] A BOOL that specifies that the default filter should be used if a more suitable one is not found.

pFilterClsid   [out] A pointer to a CLSID that receives the class ID of the returned filter.

SearchDecSize   [in, out] Not used. Value should be 0.

pwcsSearchDesc  [out, size_is(*SearchDecSize)] Not used. Value should be 0.

ppIFilt   [out] An address of a pointer that receives the pointer to the IFilter requested. The value is null if no filter is found.

Exceptions

For a list of errors returned by Microsoft SharePoint Portal Server Search IFilter administration interfaces, see IFilter Administration Error Messages.

Remarks

The LoadIFilterEx method attempts to load an IFilter that can process the data source of the type specified in the pFilteredSource parameter, located in the stream pStm.

If no suitable IFilter is found for the data source, and fUseDefault is false, this method returns null in ppIFilt parameter. If fUseDefault is true, and no suitable IFilter is found for the data source, the IFilter interface on the default IFilter is returned in ppIFilt.

The IFilter must be released after it is used.

Requirements

Platform: Microsoft Windows Server 2003