ItemChange.AddFilterChange Method

Adds 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 Sub AddFilterChange ( _
    filterKey As UInteger, _
    filterChange As FilterChange _
)
'Usage
Dim instance As ItemChange
Dim filterKey As UInteger
Dim filterChange As FilterChange

instance.AddFilterChange(filterKey, filterChange)

public void AddFilterChange (
    uint filterKey,
    FilterChange filterChange
)

public:
void AddFilterChange (
    unsigned int filterKey, 
    FilterChange^ filterChange
)

public void AddFilterChange (
    UInt32 filterKey, 
    FilterChange filterChange
)

public function AddFilterChange (
    filterKey : uint, 
    filterChange : FilterChange
)

Parameters

• filterKey
  The key of the filter that the item is moving into or out of.

• filterChange
  Information about the change in relation to the filter specified by filterKey.

Exceptions

Exception type	Condition
ArgumentNullException	A required parameter is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeException	filterKey is an invalid value.
SyncInvalidOperationException	Filter change information already exists for filterKey.

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.

Example

The following example adds filter change information to an ItemChange object when the move version for the item in relation to the filter is not contained in the destination knowledge.

Public Sub AddFilterChanges(ByVal filterKeyMap As FilterKeyMap, ByVal itemMeta As ItemMetadata, ByVal destKnowledge As SyncKnowledge, ByVal itemChange As ItemChange)
    For filterKey As Integer = 0 To filterKeyMap.Count - 1
        ' Find the filter in the list of all filters tracked by this replica.
        Dim iFilter As Integer = 0
        While iFilter < _trackedFilters.Count
            If filterKeyMap(filterKey).IsIdentical(_trackedFilters(iFilter)) Then
                Exit While
            End If
            iFilter += 1
        End While

        ' Get the filter information for the item and add it to the ItemChange object.
        Dim moveVersion As SyncVersion = GetMoveVersion(itemMeta, iFilter)

        ' Only return a filter change if the destination knowledge does not contain the version of the 
        ' last move that occurred in relation to the specified filter.
        Dim filterChange As FilterChange = Nothing
        If Not destKnowledge.Contains(ContactReplicaMetadata.ReplicaId, itemMeta.GlobalId, moveVersion) Then
            filterChange = New FilterChange(GetIsInFilter(itemMeta, iFilter), moveVersion)
            itemChange.AddFilterChange(CUInt(filterKey), filterChange)
        End If
    Next
End Sub

public void AddFilterChanges(FilterKeyMap filterKeyMap, ItemMetadata itemMeta, SyncKnowledge destKnowledge,
    ItemChange itemChange)
{
    for (int filterKey = 0; filterKey < filterKeyMap.Count; filterKey++)
    {
        // Find the filter in the list of all filters tracked by this replica.
        int iFilter = 0;
        for (; iFilter < _trackedFilters.Count; iFilter++)
        {
            if (filterKeyMap[filterKey].IsIdentical(_trackedFilters[iFilter]))
            {
                break;
            }
        }

        // Get the filter information for the item and add it to the ItemChange object.
        SyncVersion moveVersion = GetMoveVersion(itemMeta, iFilter);

        // Only return a filter change if the destination knowledge does not contain the version of the 
        // last move that occurred in relation to the specified filter.
        FilterChange filterChange = null;
        if (!destKnowledge.Contains(ContactReplicaMetadata.ReplicaId, itemMeta.GlobalId, moveVersion))
        {
            filterChange = new FilterChange(GetIsInFilter(itemMeta, iFilter), moveVersion);
            itemChange.AddFilterChange((uint)filterKey, filterChange);
        }
    }
}

See Also

Reference

ItemChange Class
ItemChange Members
Microsoft.Synchronization Namespace