LoadIFilterFromStream Method

  • Article

The LoadIFilterFromStream method of the ILoadFilter 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 holding the class ID of the data source type to be filtered.

pFilteredSources   [in] A pointer to a FILTERED_DATA_SOURCES structure from which to retrieve information.

pUnkOuter  [in] A pointer to the outer IUnknown object for the calling object.

fUseDefault   [in] A BOOL that specifies that the default filter should be used if a more suitable filter 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 to the IFilter interface of the filter chosen by the method. The value is null if none is found.

Exceptions

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

Remarks

The LoadIFilterFromStream method attempts to load an IFilter that can process the data source of the type specified in the pFilteredSources parameter located in the storage stream pStg.

If no suitable IFilter is found for the data source, and fUseDefault is false, this method returns null in the ppIFilt parameter. If no suitable IFilter is found for the data source, and fUseDefault is true, 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