BindToFilter Method

  • Article

The BindToFilter method returns a pointer to the appropriate IFilter implementation for the item so that the Filter Daemon can retrieve properties and text for the Gatherer.

Syntax
HRESULT BindToFilter(
  IFilter**ppFilter);
Parameters
  • ppFilter
    [out] Address of a pointer to the IFilter that will be used to filter this item.
Return Value

For a list of error messages returned by SharePoint Portal Server Protocol Handlers, see Error Messages.

Remarks

All protocol handlers must implement one of BindToFilter, BindToStream, or GetFilename methods for the Filter Daemon to retrieve any useful information from that item. Protocol handlers may implement either BindToFilter or BindToStream. They may implement both. For example, protocol handlers may use BindToFilter for metadata associated with items in the content source, and use BindToStream to retrieve the content of the items.

The BindToFilter method is called only once by the Filter Daemon. If an item is a document with multiple embedded documents, you must use an IFilter implementation that enumerates the embedded documents and invokes the appropriate IFilter for each.

Example

To see this method in a fuller context, see Protocol Handler Sample.