IProviderFilteredSyncServices::CreateFilterInfo
Creates an ISyncFilterInfo object that a source provider can use to communicate information about the filter that is used to control which changes are included in a change batch.
HRESULT CreateFilterInfo(
DWORD dwFlags,
ISyncFilterInfo ** ppFilterInfo);
Parameters
- dwFlags
[in] Flags that specify additional information about the filter information object to be created. Must be SYNC_FILTER_INFO_FLAG_ITEM_LIST or SYNC_FILTER_INFO_FLAG_CHANGE_UNIT_LIST.
- ppFilterInfo
[out] Returns the newly created filter information object.
Return Value
S_OK
E_INVALIDARG when dwFlags is not SYNC_FILTER_INFO_FLAG_ITEM_LIST or SYNC_FILTER_INFO_FLAG_CHANGE_UNIT_LIST.
E_OUTOFMEMORY
E_POINTER
SYNC_E_INVALID_OPERATION if this object has not been properly initialized.
Remarks
When SYNC_FILTER_INFO_FLAG_ITEM_LIST is specified for the dwFlags value, Sync Framework returns an object that implements ISyncFilterInfo. The implementation that is provided by this object serializes version information and the flags that are specified for dwFlags when its ISyncFilterInfo::Serialize method is called.
When SYNC_FILTER_INFO_FLAG_CHANGE_UNIT_LIST is specified for the dwFlags value, Sync Framework returns an object that implements IChangeUnitListFilterInfo. The implementation that is provided by this object can be used to specify that only a particular set of change units is included for items in a change batch.