Share via

ISyncChangeBatchWithFilterKeyMap::SetFilterForgottenKnowledge

  • Article

Sets the filter forgotten knowledge for the specified filter.

Syntax

HRESULT SetFilterForgottenKnowledge(
  DWORD              dwFilterKey,
  ISyncKnowledge  *  pFilterForgottenKnowledge);

Parameters

  • dwFilterKey
    [in] The filter key of the filter that pFilterForgottenKnowledge pertains to.

  • pFilterForgottenKnowledge
    [in] The filter forgotten knowledge of the filter identified by dwFilterKey.

Return Value

  • S_OK.

  • E_INVALIDARG when the change batch does not contain a filter key map, or when dwFilterKey is an invalid value.

  • E_POINTER.

  • SYNC_E_INVALID_OPERATION when a group has not been started in the change batch. This error is also returned when a filter forgotten knowledge has already been set for the filter specified by dwFilterKey.

Remarks

The filter forgotten knowledge applies to the currently open group.

See Also

Reference

ISyncChangeBatchWithFilterKeyMap Interface