Share via

IFilterTrackingSyncChangeBuilder::AddFilterChange

  • Article

Adds information that indicates whether this change causes the item to move in or out of a specified filter.

Syntax

HRESULT AddFilterChange(
  DWORD                      dwFilterKey, 
  const SYNC_FILTER_CHANGE * pFilterChange);

Parameters

  • dwFilterIndex
    [in] The index of a filter in the filter key map of the replica.

  • pFilterChange
    [in] Information about the change in relation to the filter specified by dwFilterIndex.

Return Value

  • S_OK.

  • E_INVALIDARG when dwFilterIndex is an invalid value.

  • E_OUTOFMEMORY.

  • E_POINTER.

  • SYNC_E_INVALID_OPERATION when filter change information already exists for dwFilterIndex.

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 provider that represents a replica that tracks filters must call this method to set filter tracking information about each change that is enumerated.

See Also

Reference

IFilterTrackingSyncChangeBuilder Interface