Share via


SyncKnowledge.ContainsMarker Method

Indicates whether the specified item is marked with the specified marker type.

Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (in microsoft.synchronization.dll)

Syntax

'Declaration
Public Function ContainsMarker ( _
    markerType As MarkerType, _
    itemId As SyncId _
) As Boolean
'Usage
Dim instance As SyncKnowledge
Dim markerType As MarkerType
Dim itemId As SyncId
Dim returnValue As Boolean

returnValue = instance.ContainsMarker(markerType, itemId)
public bool ContainsMarker (
    MarkerType markerType,
    SyncId itemId
)
public:
bool ContainsMarker (
    MarkerType markerType, 
    SyncId^ itemId
)
public boolean ContainsMarker (
    MarkerType markerType, 
    SyncId itemId
)
public function ContainsMarker (
    markerType : MarkerType, 
    itemId : SyncId
) : boolean

Parameters

  • markerType
    The type of marker to look up.
  • itemId
    The ID of the item to be looked up.

Return Value

true when itemId is marked with the specified marker type. Otherwise, false.

Exceptions

Exception type Condition

ArgumentOutOfRangeException

markerType is not a valid value.

InvalidKnowledgeVersionException

The CompatibilityLevel property is less than SyncFrameworkVersion2.

SyncIdFormatMismatchException

itemId is not in the ID format specified for this knowledge object.

Remarks

When custom filters are used, the source provider must call ContainsMarker with markerType set to AllChangeUnitsRequired, to check whether items that are added to a change batch require that all change units are included. 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

SyncKnowledge Class
SyncKnowledge Members
Microsoft.Synchronization Namespace