SaveChangeWithChangeUnitsContext.GetUpdatedFilterForgottenKnowledge Method
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 SaveChangeWithChangeUnitsContext
Dim filterIndex As UInteger
Dim returnValue As ForgottenKnowledge
returnValue = instance.GetUpdatedFilterForgottenKnowledge(filterIndex)
public ForgottenKnowledge GetUpdatedFilterForgottenKnowledge(
uint filterIndex
)
public:
ForgottenKnowledge^ GetUpdatedFilterForgottenKnowledge(
unsigned int filterIndex
)
member GetUpdatedFilterForgottenKnowledge :
filterIndex:uint32 -> ForgottenKnowledge
public function GetUpdatedFilterForgottenKnowledge(
filterIndex : uint
) : ForgottenKnowledge
Parameters
- filterIndex
Type: System.UInt32
The index that identifies the filter in the filter key map of the destination replica.
Return Value
Type: Microsoft.Synchronization.ForgottenKnowledge
The filter forgotten knowledge for the specified filter.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | filterIndex is not a valid 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.