Share via

LoadIFilterEx Method

  • Article

The LoadIFilterEx method of the IFilterRegistration interface retrieves the appropriate IFilter for the data source that you specify.

Parameters

pwcsPath  [in] A pointer to a WCHAR that contains a path or Uniform Resource Indicator (URI) of the file to be filtered. Can also be 0 if IPersist*::Load should not be called on the file/stream/storage.

pFilteredSource   [in] A pointer to a FILTERED_DATA_SOURCE structure that contains the IFilter for which the method retrieves information.

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 requested IFilter. 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 to process the data source of the type specified in the pFilteredSource parameter, located at pwcsPath.

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

The IFilter must be released after it is used.

Requirements

Platform: Microsoft Windows Server 2003