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)
Syntax
'Declaration
Public Sub GetFilterChange ( _
filterKey As UInteger, _
<OutAttribute> ByRef filterTrackingStatus As FilterTrackingStatus, _
<OutAttribute> ByRef filterChange As FilterChange _
)
'Usage
Dim instance As ItemChange
Dim filterKey As UInteger
Dim filterTrackingStatus As FilterTrackingStatus
Dim filterChange As FilterChange
instance.GetFilterChange(filterKey, filterTrackingStatus, _
filterChange)
public void GetFilterChange(
uint filterKey,
out FilterTrackingStatus filterTrackingStatus,
out FilterChange filterChange
)
public:
void GetFilterChange(
unsigned int filterKey,
[OutAttribute] FilterTrackingStatus% filterTrackingStatus,
[OutAttribute] FilterChange^% filterChange
)
member GetFilterChange :
filterKey:uint32 *
filterTrackingStatus:FilterTrackingStatus byref *
filterChange:FilterChange byref -> unit
public function GetFilterChange(
filterKey : uint,
filterTrackingStatus : FilterTrackingStatus,
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.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | filterKey is an invalid value. |
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.