Share via

SaveChangeContext.GetUpdatedFilterForgottenKnowledge Method

  • Article

Gets the updated filter forgotten knowledge for the specified filter.

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

Syntax

'Declaration
Public Function GetUpdatedFilterForgottenKnowledge ( _
    filterIndex As UInteger _
) As ForgottenKnowledge
'Usage
Dim instance As SaveChangeContext
Dim filterIndex As UInteger
Dim returnValue As ForgottenKnowledge

returnValue = instance.GetUpdatedFilterForgottenKnowledge(filterIndex)

public ForgottenKnowledge GetUpdatedFilterForgottenKnowledge (
    uint filterIndex
)

public:
ForgottenKnowledge^ GetUpdatedFilterForgottenKnowledge (
    unsigned int filterIndex
)

public ForgottenKnowledge GetUpdatedFilterForgottenKnowledge (
    UInt32 filterIndex
)

public function GetUpdatedFilterForgottenKnowledge (
    filterIndex : uint
) : ForgottenKnowledge

Parameters

  • filterIndex
    The index that identifies the filter in the filter key map of the destination replica.

Return Value

The filter forgotten knowledge for the specified filter.

Exceptions

Exception type Condition

ArgumentException

filterIndex is an invalid value.

Remarks

A destination provider that represents a replica that tracks filters must call this method to retrieve updated information about each change that is applied to the destination replica. When this method returns a value that is not a null reference (Nothing in Visual Basic), the destination provider must replace the filter forgotten knowledge of the destination replica. If this method returns a null reference (Nothing in Visual Basic), the current filter forgotten knowledge of the destination replica must be kept.

See Also

Reference

SaveChangeContext Class
SaveChangeContext Members
Microsoft.Synchronization Namespace