DbSyncSessionProgressEventArgs Class

Provides data for the SessionProgress event.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.Synchronization.SyncStagedProgressEventArgs
      Microsoft.Synchronization.Data.DbSyncSessionProgressEventArgs

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DbSyncSessionProgressEventArgs _
    Inherits SyncStagedProgressEventArgs
'Usage
Dim instance As DbSyncSessionProgressEventArgs

[CLSCompliantAttribute(false)]
public class DbSyncSessionProgressEventArgs : SyncStagedProgressEventArgs

[CLSCompliantAttribute(false)]
public ref class DbSyncSessionProgressEventArgs : public SyncStagedProgressEventArgs

[<CLSCompliantAttribute(false)>]
type DbSyncSessionProgressEventArgs =  
    class
        inherit SyncStagedProgressEventArgs
    end

public class DbSyncSessionProgressEventArgs extends SyncStagedProgressEventArgs

The DbSyncSessionProgressEventArgs type exposes the following members.

Constructors

	Name	Description
	DbSyncSessionProgressEventArgs	Initializes a new instance of the DbSyncSessionProgressEventArgs class by using synchronization session, synchronization stage, percent completed, scope progress, batch number, batch count, provider position, and progress stage parameters.

Top

Properties

	Name	Description
	BatchCount	Gets the total number of batches to be processed in this synchronization session.
	BatchNumber	Gets the number of the batch that is currently being processed.
	CompletedWork	Gets the amount of work that is currently completed in the session. (Inherited from SyncStagedProgressEventArgs.)
	DbSyncStage	Gets a DbSyncStage enumeration value that represents the current stage of synchronization.
	GroupProgress	Gets a DbSyncScopeProgress object that contains a set of progress statistics for a synchronization scope.
	ReportingProvider	Gets the position of the provider that is associated with this event. (Inherited from SyncStagedProgressEventArgs.)
	Session	Gets a DbSyncSession object that contains metadata about the current synchronization session, such as the ID of the peer that is synchronizing.
	Stage	Gets the current stage of the synchronization session. (Inherited from SyncStagedProgressEventArgs.)
	TotalWork	Gets the total work for the session. (Inherited from SyncStagedProgressEventArgs.)

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

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.

See Also

Reference

Microsoft.Synchronization.Data Namespace