ChangeBatchBase::SetFilterForgottenKnowledge Method

Sets the filter forgotten knowledge for the specified filter.

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

public:
void SetFilterForgottenKnowledge(
	unsigned int filterKey, 
	SyncKnowledge^ filterForgottenKnowledge
)

Parameters

filterKey
Type: System::UInt32
The filter key of the filter that filterForgottenKnowledge pertains to.
filterForgottenKnowledge
Type: Microsoft.Synchronization::SyncKnowledge
The filter forgotten knowledge of the filter identified by filterKey.

ExceptionCondition
ArgumentException

The change batch does not contain a filter key map, or filterKey is an invalid value.

ArgumentNullException

filterKey is a nullptr.

ObjectDisposedException

This ChangeBatchBase has been disposed.

SyncInvalidOperationException

A group has not been started in the change batch. This exception is also thrown when a filter forgotten knowledge has already been set for the filter specified by filterKey.

The filter forgotten knowledge applies to the currently open group.

Show: