Fonction CfReportSyncStatus (cfapi.h)

Permet à un fournisseur de synchronisation d’informer la plateforme de ses status sur une racine de synchronisation spécifiée sans avoir à se connecter au préalable à CfConnectSyncRoot.

Syntaxe

HRESULT CfReportSyncStatus(
  [in, out] LPCWSTR        SyncRootPath,
  [in]      CF_SYNC_STATUS *SyncStatus
);

Paramètres

[in, out] SyncRootPath

Chemin d’accès à la racine de synchronisation.

[in] SyncStatus

La synchronisation status à signaler ; si NULL, efface le status de synchronisation précédemment enregistré. Pour plus d’informations, consultez la section Remarques ci-dessous.

Valeur retournée

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Lorsqu’une CF_SYNC_STATUS non null est fournie dans le paramètre SyncStatus , les informations sont mémorisées sur la racine de synchronisation jusqu’à ce qu’elles soient effacées explicitement par le fournisseur de synchronisation ou lorsque la machine redémarre. La plateforme interroge ces informations en cas d’échec d’opérations sur un espace réservé de fichier cloud, à l’aide du processus suivant :

1. La plateforme recherche d’abord les status de synchronisation au niveau du fichier.
2. Si aucune status de synchronisation n’est trouvée, la plateforme recherche ensuite les status de synchronisation inscrites au niveau racine de synchronisation, ce qui est effectué via cette fonction.
3. Une fois qu’une status de synchronisation est localisée, la plateforme utilise les informations fournies pour créer un message plus explicite et actionnable à l’utilisateur.

CfReportSyncStatus efface les status de synchronisation précédemment enregistrées lors de l’appel avec un NULL status de synchronisation. Aucune modification n’est apportée au status de synchronisation existant si l’appel de fonction échoue.

Configuration requise

Voir aussi

CfConnectSyncRoot

CF_SYNC_STATUS