IFilterTrackingNotifyingChangeApplierTarget.GetFilterForgottenKnowledge Method

When overridden in a derived class, gets the specified filter forgotten knowledge of the replica.

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

Syntax

'Declaration
Function GetFilterForgottenKnowledge ( _
    filterIndex As UInteger _
) As ForgottenKnowledge
'Usage
Dim instance As IFilterTrackingNotifyingChangeApplierTarget
Dim filterIndex As UInteger
Dim returnValue As ForgottenKnowledge

returnValue = instance.GetFilterForgottenKnowledge(filterIndex)

ForgottenKnowledge GetFilterForgottenKnowledge (
    uint filterIndex
)

ForgottenKnowledge^ GetFilterForgottenKnowledge (
    unsigned int filterIndex
)

ForgottenKnowledge GetFilterForgottenKnowledge (
    UInt32 filterIndex
)

function GetFilterForgottenKnowledge (
    filterIndex : uint
) : ForgottenKnowledge

Parameters

• filterIndex
  The filter key of the filter that is associated with the filter forgotten knowledge to look up.

Return Value

The filter forgotten knowledge that is associated with the filter identified by filterIndex. This value can be a null reference (Nothing in Visual Basic) when the filter forgotten knowledge is the same as the forgotten knowledge of the replica.

Remarks

A replica tracks a filter when it stores metadata that indicates whether an item is in the filter, and whether an item has been in the filter but has moved out. The replica might also contain filter forgotten knowledge for the filter, if it has removed metadata that tracks whether an item has been in the filter but has moved out, or if the replica does not track the filter the first time it synchronizes with a filtered replica and begins tracking the filter at a later time.

Example

The following example uses a FilterKeyMap object to retrieve the requested filter forgotten knowledge.

Public Function GetFilterForgottenKnowledge(ByVal filterIndex As UInteger) As ForgottenKnowledge Implements IFilteredReplicaNotifyingChangeApplierTarget.GetFilterForgottenKnowledge
    If filterIndex < _filterKeyMap.Count Then
        Return DirectCast(_filterKeyMap(CInt(filterIndex)), AddressFilter).FilterForgottenKnowledge
    Else
        Throw New ArgumentOutOfRangeException("GetFilterForgottenKnowledge received and out-of-range index.")
    End If
End Function

public ForgottenKnowledge GetFilterForgottenKnowledge(uint filterIndex)
{
    if (filterIndex < _filterKeyMap.Count)
    {
        return ((AddressFilter)_filterKeyMap[(int)filterIndex]).FilterForgottenKnowledge;
    }
    else
    {
        throw new ArgumentOutOfRangeException("GetFilterForgottenKnowledge received and out-of-range index.");
    }
}

See Also

Reference

IFilterTrackingNotifyingChangeApplierTarget Interface
IFilterTrackingNotifyingChangeApplierTarget Members
Microsoft.Synchronization Namespace