Fonction CfDisconnectSyncRoot (cfapi.h)
Déconnecte un canal de communication créé par CfConnectSyncRoot.
Syntaxe
HRESULT CfDisconnectSyncRoot(
[in] CF_CONNECTION_KEY ConnectionKey
);
Paramètres
[in] ConnectionKey
Clé de connexion retournée par CfConnectSyncRoot qui est maintenant utilisée pour déconnecter la racine de synchronisation.
Valeur retournée
Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.
Remarques
Cela supprime le canal de communication avec la plateforme précédemment établie à l’aide de CfConnectSyncRoot.
Un fournisseur de synchronisation peut toujours recevoir des rappels pendant l’appel CfDisconnectSyncRoot , et il est libre de choisir si l’appel doit échouer ou être résolu. Les deux choix ne provoquent pas de perturbations pour le fournisseur de synchronisation.
Une fois qu’un appel à CfDisconnectSyncRoot est retourné, le fournisseur de synchronisation ne reçoit plus de rappels et la plateforme échoue toute opération qui dépend de ces rappels.
Un fournisseur de synchronisation doit avoir WRITE_DATA ou WRITE_DAC accès à la racine de synchronisation à déconnecter, sinon un appel à CfDisconnectSyncRoot échoue avec HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED). En outre, si la racine de synchronisation n’a pas été connectée précédemment, l’appel échoue avec des paramètres non valides. Cette API peut être appelée dans le cadre de l’arrêt du fournisseur de synchronisation. Toutefois, si le processus du fournisseur de synchronisation choisit de s’arrêter sans appeler cette API, ou s’il se bloque de manière inattendue, la plateforme le détecte et effectue le nettoyage nécessaire.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows 10, version 1709 [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2016 (applications de bureau uniquement) |
| Plateforme cible | Windows |
| En-tête | cfapi.h |
| Bibliothèque | CldApi.lib |
| DLL | CldApi.dll |