Share via


ItemChange.GetFilterChange Method

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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

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

Syntax

'Declaration
Public Function GetFilterChange ( _
    filterKey As UInteger _
) As FilterChange
'Usage
Dim instance As ItemChange
Dim filterKey As UInteger
Dim returnValue As FilterChange

returnValue = instance.GetFilterChange(filterKey)
public FilterChange GetFilterChange (
    uint filterKey
)
public:
FilterChange^ GetFilterChange (
    unsigned int filterKey
)
public FilterChange GetFilterChange (
    UInt32 filterKey
)
public function GetFilterChange (
    filterKey : uint
) : FilterChange

Parameters

  • filterKey
    The key of the filter to look up.

Return Value

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

Exceptions

Exception type 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.

See Also

Reference

ItemChange Class
ItemChange Members
Microsoft.Synchronization Namespace