Méthode ReplicaMetadata.CleanupDeletedItems

En cas de substitution dans une classe dérivée, supprime les éléments marqués comme supprimés et antérieurs à la dernière heure de nettoyage réussi.

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

Syntaxe

'Déclaration
Public MustOverride Function CleanupDeletedItems ( _
    timeInterval As TimeSpan _
) As Boolean
'Utilisation
Dim instance As ReplicaMetadata
Dim timeInterval As TimeSpan
Dim returnValue As Boolean

returnValue = instance.CleanupDeletedItems(timeInterval)

public abstract bool CleanupDeletedItems (
    TimeSpan timeInterval
)

public:
virtual bool CleanupDeletedItems (
    TimeSpan timeInterval
) abstract

public abstract boolean CleanupDeletedItems (
    TimeSpan timeInterval
)

public abstract function CleanupDeletedItems (
    timeInterval : TimeSpan
) : boolean

Paramètres

• timeInterval
  Ancienneté minimale des éléments supprimés à conserver dans le magasin des métadonnées. La valeur 0 signifie que tous les éléments supprimés sont nettoyés immédiatement.

Valeur de retour

true si le nettoyage a été effectué ; sinon, false.

Exceptions

Notes

Cette méthode permet à un fournisseur de nettoyer les éléments supprimés selon une planification. L'intervalle de temps spécifié par timeInterval correspond à l'ancienneté minimale des éléments supprimés qui sont conservés dans le magasin des métadonnées. Dans la mesure où elle nettoie uniquement les éléments supprimés lorsque le temps timeInterval est écoulé, CleanupDeletedItems peut être appelée régulièrement, par exemple chaque fois que le fournisseur effectue une détection de modifications. En conservant toujours les éléments supprimés marqués comme supprimés pendant timeInterval, CleanupDeletedItems permet d'épargner au fournisseur des énumérations complètes coûteuses.

La première fois que CleanupDeletedItems est appelée, l'heure actuelle est stockée comme dernière heure de nettoyage réussi et aucune autre action n'est effectuée.

Chaque fois que CleanupDeletedItems est appelée par la suite, elle effectue les étapes ci-après.

1. Vérifie l'heure actuelle par rapport à la dernière heure de nettoyage réussi. Si le temps écoulé est inférieur à timeInterval, aucune action supplémentaire n'est effectuée et la valeur false est retournée.

2. Supprime tous les éléments supprimés antérieurs à la dernière heure de nettoyage réussi.

3. Enregistre l'heure actuelle comme dernière heure de nettoyage réussi.

4. Met à jour la connaissance oubliée pour refléter les éléments supprimés qui ont été retirés.

Gardez à l'esprit que CleanupDeletedItems nettoie seulement les éléments marqués comme supprimés avant la dernière heure de nettoyage réussi, et non les éléments marqués comme supprimés depuis la dernière heure de nettoyage réussi. Par exemple, CleanupDeletedItems nettoie les éléments avec succès et stocke l'heure actuelle. 24 jours plus tard, CleanupDeletedItems est à nouveau appelée avec la valeur 20 jours spécifiée pour timeInterval. CleanupDeletedItems supprime uniquement les éléments supprimés antérieurs à 24 jours, car il s'agit du moment où le dernier nettoyage réussi a été effectué. Un élément marqué comme supprimé entre 24 et 20 jours (par exemple 22 jours) ne sera pas supprimé. Tout élément supprimé qui ne date pas de plus de 20 jours ne sera pas supprimé.

Voir aussi

Référence

Classe ReplicaMetadata
Membres ReplicaMetadata
Espace de noms Microsoft.Synchronization.MetadataStorage