IFilteredSimpleSyncProvider.IsItemInFilterScope 方法

当在派生类中重写时，由 Sync Framework 运行时调用以确定某一项是否满足提供程序的筛选条件。

命名空间: Microsoft.Synchronization.SimpleProviders
程序集: Microsoft.Synchronization.SimpleProviders（在 microsoft.synchronization.simpleproviders.dll 中）

语法

声明
Function IsItemInFilterScope ( _
    keyAndVersion As ItemFieldDictionary _
) As Boolean
用法
Dim instance As IFilteredSimpleSyncProvider
Dim keyAndVersion As ItemFieldDictionary
Dim returnValue As Boolean

returnValue = instance.IsItemInFilterScope(keyAndVersion)

bool IsItemInFilterScope (
    ItemFieldDictionary keyAndVersion
)

bool IsItemInFilterScope (
    ItemFieldDictionary^ keyAndVersion
)

boolean IsItemInFilterScope (
    ItemFieldDictionary keyAndVersion
)

function IsItemInFilterScope (
    keyAndVersion : ItemFieldDictionary
) : boolean

参数

• keyAndVersion
  一个 ItemFieldDictionary 对象，该对象包含要检查的项的键和版本。

返回值

如果项满足筛选条件，则为 True。否则为 false。

示例

下面的代码示例首先指定 None 的筛选器选项。这意味着项应该首先筛选出来，即使它们对于目标是已知的。该代码示例然后实现 IsItemInFilterScope 方法，该方法基于项字段值之一筛选出项。在定义筛选器后，该代码示例实现 UseFilterThisSession 方法。这使得应用程序可以指定是否应在每个会话的基础上使用筛选。

SimpleSyncProviderFilterOptions IFilteredSimpleSyncProvider.FilterOptions
{
    get
    {
        return SimpleSyncProviderFilterOptions.None;
    }
}

bool IFilteredSimpleSyncProvider.IsItemInFilterScope(ItemFieldDictionary KeyAndVersion)
{
    ulong itemId = (ulong)KeyAndVersion[1].Value;
    ItemData itemData = _store.Get(itemId);
    if (itemData["data"] == "3333")
    {
        return false;
    }

    return true;
}

bool IFilteredSimpleSyncProvider.UseFilterThisSession
{
    get
    {
        // Indicate whether a filter has been requested and agreed upon for this session.
        return ("" != _filter);
    }
}

Private ReadOnly Property FilterOptions() As SimpleSyncProviderFilterOptions Implements IFilteredSimpleSyncProvider.FilterOptions
    Get
        Return SimpleSyncProviderFilterOptions.None
    End Get
End Property

Private Function IsItemInFilterScope(ByVal KeyAndVersion As ItemFieldDictionary) As Boolean Implements IFilteredSimpleSyncProvider.IsItemInFilterScope
    Dim itemId As ULong = KeyAndVersion(1).Value
    Dim data As ItemData = _store.Get(itemId)
    If data("data") Is "3333" Then
        Return False
    End If

    Return True
End Function

Private ReadOnly Property UseFilterThisSession() As Boolean Implements IFilteredSimpleSyncProvider.UseFilterThisSession
    Get
        ' Indicate whether a filter has been requested and agreed upon for this session.
        Return "" Is _filter
    End Get
End Property

请参阅

参考

IFilteredSimpleSyncProvider 接口
IFilteredSimpleSyncProvider 成员
Microsoft.Synchronization.SimpleProviders 命名空间