ChangeBatchBase.SetFilterForgottenKnowledge Method

  • Article

Sets the filter forgotten knowledge for the specified filter.

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

Syntax

'Declaration
Public Sub SetFilterForgottenKnowledge ( _
    filterKey As UInteger, _
    filterForgottenKnowledge As SyncKnowledge _
)
'Usage
Dim instance As ChangeBatchBase
Dim filterKey As UInteger
Dim filterForgottenKnowledge As SyncKnowledge

instance.SetFilterForgottenKnowledge(filterKey, _
    filterForgottenKnowledge)

public void SetFilterForgottenKnowledge(
    uint filterKey,
    SyncKnowledge filterForgottenKnowledge
)

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

member SetFilterForgottenKnowledge : 
        filterKey:uint32 * 
        filterForgottenKnowledge:SyncKnowledge -> unit 

public function SetFilterForgottenKnowledge(
    filterKey : uint, 
    filterForgottenKnowledge : SyncKnowledge
)

Parameters

  • filterKey
    Type: System.UInt32
    The filter key of the filter that filterForgottenKnowledge pertains to.

Exceptions

Exception Condition
ArgumentException

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

filterKey is a null reference (Nothing in Visual Basic).
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.

Remarks

The filter forgotten knowledge applies to the currently open group.

See Also

Reference

ChangeBatchBase Class

Microsoft.Synchronization Namespace