ItemChange::GetFilterChange Method

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

Namespace:  Microsoft.Synchronization
Assembly:  Microsoft.Synchronization (in Microsoft.Synchronization.dll)

public:
void GetFilterChange(
	unsigned int filterKey, 
	[OutAttribute] FilterTrackingStatus% filterTrackingStatus, 
	[OutAttribute] FilterChange^% filterChange
)

Parameters

filterKey
Type: System::UInt32
The key of the filter to look up.
filterTrackingStatus
Type: Microsoft.Synchronization::FilterTrackingStatus%
Returns a value that indicates whether the provider that sent this change is tracking the specified filter.
filterChange
Type: Microsoft.Synchronization::FilterChange%
Returns information that indicates whether this change causes the item to move into or out of the specified filter.

ExceptionCondition
ArgumentOutOfRangeException

filterKey is an invalid value.

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.

Show: