Méthode SyncSessionContext.OnProgressChanged

Article
09/18/2009

Signale la progression de la synchronisation à l'application.

Espace de noms: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (dans microsoft.synchronization.dll)

Syntaxe

'Déclaration
Public Sub OnProgressChanged ( _
    e As SyncStagedProgressEventArgs _
)
'Utilisation
Dim instance As SyncSessionContext
Dim e As SyncStagedProgressEventArgs

instance.OnProgressChanged(e)

public void OnProgressChanged (
    SyncStagedProgressEventArgs e
)

public:
void OnProgressChanged (
    SyncStagedProgressEventArgs^ e
)

public void OnProgressChanged (
    SyncStagedProgressEventArgs e
)

public function OnProgressChanged (
    e : SyncStagedProgressEventArgs
)

Paramètres

e
Objet SyncStagedProgressEventArgs qui contient les données d'événement.

Notes

La méthode peut être utilisée pour signaler une progression personnalisée à l'application. Quand un fournisseur appelle cette méthode, l'événement SyncOrchestrator.SessionProgress est déclenché.

Quand ChangeApplication est spécifié pour la propriété Stage de e, Sync Framework cumule le travail total achevé défini par la propriété CompletedWork de e à chaque appel de OnProgressChanged. Sync Framework interprète aussi la propriété TotalWork de e comme travail restant pour la session et calcule le travail total de la session en ajoutant TotalWork à la valeur cumulée du travail achevé. Sync Framework transmet ensuite ces valeurs calculées à SyncOrchestrator.SessionProgress. Quand la propriété Stage de e correspond à une autre valeur valide, CompletedWork et TotalWork sont transmis directement à SyncOrchestrator.SessionProgress.

Quand le fournisseur de source spécifie les estimations de travail, des résultats inattendus peuvent se produire si un fournisseur appelle OnProgressChanged et spécifie ChangeApplication pour la propriété Stage de e. La raison en est que Sync Framework totalise la valeur du travail réalisé chaque fois qu'une notification de progression est envoyée durant l'application de la modification. Si un fournisseur envoie sa propre notification de progression et spécifie ChangeApplication pour Stage, Sync Framework ajoute les valeurs de travail estimées qui sont spécifiées par le fournisseur au travail total réalisé pour la session. Le même travail peut alors être compté deux fois : une fois lorsqu'il est signalé par Sync Framework et l'autre fois lorsqu'il est signalé par le fournisseur.

Voir aussi

Référence

Classe SyncSessionContext
Membres SyncSessionContext
Espace de noms Microsoft.Synchronization

Partager via