ISyncChangeWithFilterKeyMap::GetFilterChange
Gets a value that indicates whether this item has been in the specified filter.
Syntax
HRESULT GetFilterChange(
DWORD dwFilterKey,
SYNC_FILTER_CHANGE * pFilterChange);
Parameters
dwFilterKey
[in] The key that identifies the filter in the filter key map of the destination replica.pfHasBeenInTheFilter
[out] Returns information that indicates whether this change causes the item to move into or out of the filter identified by dwFilterKey.
Return Value
S_OK.
S_FALSE when the source provider does not track the specified filter.
E_INVALIDARG when dwFilterIndex is an invalid value.
E_POINTER.
SYNC_E_SOURCE_DOES_NOT_TRACK_FILTER when the specified filter is not tracked.
Remarks
A change can cause an item to move into or out of a filter. For example, items contain a state field, and a filter excludes any item with its state field equal to "Washington". When an item with state equal to "Washington" changes so that state equals "Oregon", the item moves into the filter.
A destination provider that represents a replica that tracks filters must call this method to retrieve updated information about each change that is applied to the destination replica.