FullEnumerationContext Class

The synchronization session context that is passed to an FullEnumerationSimpleSyncProvider object.

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.SimpleProviders.ItemEnumerationContext
Microsoft.Synchronization.SimpleProviders.FullEnumerationContext

Namespace: Microsoft.Synchronization.SimpleProviders
Assembly: Microsoft.Synchronization.SimpleProviders (in Microsoft.Synchronization.SimpleProviders.dll)

Syntax

'Declaration
Public Class FullEnumerationContext _
    Inherits ItemEnumerationContext
'Usage
Dim instance As FullEnumerationContext

public class FullEnumerationContext : ItemEnumerationContext

public ref class FullEnumerationContext : public ItemEnumerationContext

type FullEnumerationContext =  
    class
        inherit ItemEnumerationContext
    end

public class FullEnumerationContext extends ItemEnumerationContext

The FullEnumerationContext type exposes the following members.

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ReportItems	Reports items that were enumerated from the local replica.
	SetDeleteMode	Sets whether a delete is a normal delete that is propagated to other replicas, or a local-only delete. (Inherited from ItemEnumerationContext.)
	SkipChangeDetection	Called by a provider to cause the Sync Framework runtime to skip change detection for a synchronization session.
	ToString	(Inherited from Object.)

Top

Remarks

The context can be used by the provider in circumstances when the provider is not going to return an enumeration of items or where the provider needs to modify the enumeration behavior of the Sync Framework runtime.

Examples

The following code example shows the FullEnumerationContext object being passed to the EnumerateItems method, and the ReportItems method being called on the context object. To view this code in the context of a complete application, see the "Sync101 using Simple Sync Provider" application that is available in the Sync Framework SDK and from Code Gallery.

public override void EnumerateItems(FullEnumerationContext context)
{
    List<ItemFieldDictionary> items = new List<ItemFieldDictionary>();
    foreach (ulong id in _store.Ids)
    {
        items.Add(_store.CreateItemFieldDictionary(id));
    }
    context.ReportItems(items);
}

Public Overrides Sub EnumerateItems(ByVal context As FullEnumerationContext)
    Dim items As New List(Of ItemFieldDictionary)()
    For Each id As ULong In _store.Ids
        items.Add(_store.CreateItemFieldDictionary(id))
    Next
    context.ReportItems(items)
End Sub

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Dela via