IKnowledgeWithMarkers::NextAllChangeUnitsRequiredMarker

Returns the next item in the list of items that are marked as requiring all change units.

HRESULT NextAllChangeUnitsRequiredMarker(
  BYTE * pItemId,
  DWORD * pIdSize);

Parameters

  • pItemId
    [in, out, unique, size_is(*pIdSize)] Returns the next item ID in the list of item IDs that are marked as requiring all change units.
  • pIdSize
    [in, out] Specifies the number of bytes in pItemId. Returns either the number of bytes that are required to retrieve the ID when pItemId is too small, or the number of bytes written.

Return Value

  • S_OK.

  • S_FALSE when there are no more items in the list or the knowledge object contains items that are marked as containing all change units.

  • HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pItemId is too small. In this situation, the required number of bytes is returned in pIdSize.

  • E_INVALIDARG when pIdSize is larger than the maximum size specified by the item ID format schema.

  • E_POINTER when item IDs are variable length and pIdSize is NULL.

Remarks

When custom filters are used, the source provider must check whether items that are added to a change batch require that all change units are included. To do this, call either IKnowledgeWithMarkers::ContainsAllChangeUnitsRequiredMarker, or enumerate items by using NextAllChangeUnitsRequiredMarker. When an item is marked as requiring all change units, the source provider must include all change units that pass the filter for that item.

See Also

Reference

IKnowledgeWithMarkers Interface