IFilterRequestCallback::RequestFilter method (winsync.h)

Requests that the filter that is specified by the destination provider be used by the source provider during change enumeration.

Syntax

HRESULT RequestFilter(
  [in] IUnknown       *pFilter,
  [in] FILTERING_TYPE filteringType
);

[in] pFilter

The filter that is specified by the destination provider. This filter is passed to the source provider to be used during change enumeration.

[in] filteringType

A FILTERING_TYPE enumeration value that indicates the type of information that is included in a change batch during filtered synchronization.

The possible return codes include, but are not limited to, the values shown in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	Invalid pointer.
SYNC_E_FILTER_NOT_SUPPPORTED	When the filter that is specified by pFilter is not supported by the source provider. This is also returned when the source provider does not implement ISupportFilteredSync.

Filter negotiation is achieved by using the following steps:

Before the source provider begins enumerating changes, starts filter negotiation by calling IRequestFilteredSync::SpecifyFilter on the destination provider.
During processing of IRequestFilteredSync::SpecifyFilter, the destination provider passes filters to IFilterRequestCallback::RequestFilter.
During processing of IFilterRequestCallback::RequestFilter, calls ISupportFilteredSync::AddFilter on the source provider. If the source provider does not support the requested filter, the destination provider can continue to request filters until it finds one that is supported.

When a filter has been successfully negotiated, the source provider uses it to determine which items to include during change enumeration.

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	winsync.h