Skip to content

Latest commit

 

History

History
136 lines (106 loc) · 5.28 KB

nf-winsync-isupportfilteredsync-addfilter.md

File metadata and controls

136 lines (106 loc) · 5.28 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winsync.ISupportFilteredSync.AddFilter
ISupportFilteredSync::AddFilter (winsync.h)
Sets the filter that is used for change enumeration by the source provider, when implemented by a derived class.
AddFilter
AddFilter method [Windows Sync]
AddFilter method [Windows Sync]
ISupportFilteredSync interface
ISupportFilteredSync interface [Windows Sync]
AddFilter method
ISupportFilteredSync.AddFilter
ISupportFilteredSync::AddFilter
winsync.isupportfilteredsync_addfilter
winsync/ISupportFilteredSync::AddFilter
winsync\isupportfilteredsync_addfilter.htm
winsync
00a533fa-2a91-46e8-9754-af162a5e59ec
12/05/2018
AddFilter, AddFilter method [Windows Sync], AddFilter method [Windows Sync],ISupportFilteredSync interface, ISupportFilteredSync interface [Windows Sync],AddFilter method, ISupportFilteredSync.AddFilter, ISupportFilteredSync::AddFilter, winsync.isupportfilteredsync_addfilter, winsync/ISupportFilteredSync::AddFilter
winsync.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Windows
19H1
ISupportFilteredSync::AddFilter
winsync/ISupportFilteredSync::AddFilter
c++
APIRef
kbSyntax
COM
winsync.h
ISupportFilteredSync.AddFilter

ISupportFilteredSync::AddFilter

-description

Sets the filter that is used for change enumeration by the source provider, when implemented by a derived class.

-parameters

-param pFilter [in]

The filter that is used for change enumeration by the source provider.

-param filteringType [in]

A FILTERING_TYPE enumeration value that indicates the type of information that is included in a change batch during filtered synchronization.

-returns

The possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
S_OK
 The method succeeded.
SYNC_E_FILTER_NOT_SUPPORTED
 When the type of filter that is specified by pFilter is not supported.
Provider-determined error codes.

-remarks

Filter negotiation is achieved by using the following steps:

  1. Before the source provider begins enumerating changes, a synchronization session typically starts filter negotiation by calling IRequestFilteredSync::SpecifyFilter on the destination provider.
  2. During processing of IRequestFilteredSync::SpecifyFilter, the destination provider passes filters to IFilterRequestCallback::RequestFilter.
  3. During processing of IFilterRequestCallback::RequestFilter, a synchronization session typically calls ISupportFilteredSync::AddFilter on the source provider. If the source provider does not support the requested filter, the destination provider can continue to request filters until it finds one that is supported.
When a filter has been successfully negotiated, the source provider uses it to determine which items to include during change enumeration.
Note  An implementation of this method can examine the filter specified by pFilter and filteringType, and return SYNC_E_FILTER_NOT_SUPPORTED to indicate that the filter is not supported. The destination provider can then request different filters until one is found that is supported.

Typically the destination provider will end the synchronization session when an error other than SYNC_E_FILTER_NOT_SUPPORTED is returned from ISupportFilteredSync::AddFilter.

 

-see-also

FILTERING_TYPE Enumeration

IFilterRequestCallback Interface

IRequestFilteredSync Interface

ISupportFilteredSync Interface