Fonction CfGetTransferKey (cfapi.h)
CfGetTransferKey retourne TransferKey, qui est nécessaire pour lancer un transfert de données dans un espace réservé à l’aide de l’API CfExecute .
Syntaxe
HRESULT CfGetTransferKey(
[in] HANDLE FileHandle,
[out] CF_TRANSFER_KEY *TransferKey
);
Paramètres
[in] FileHandle
Handle de fichier de l’espace réservé.
[out] TransferKey
Handle opaque pour l’espace réservé à traiter.
Valeur retournée
Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.
Remarques
Cette API est disponible pour les fournisseurs de synchronisation qui souhaitent lancer de manière proactive un transfert de données dans un espace réservé, en guise d’alternative à l’appel de CfHydratePlaceholder. CfGetTransferKey retourne la même clé de transfert qu’un rappel de données d’extraction aurait retourné. Le fournisseur de synchronisation peut ensuite passer la clé de transfert dans les appels suivants à l’API CfExecute . De cette façon, le transfert de données est piloté par le fournisseur de synchronisation plutôt que par le filtre.
Un fournisseur de synchronisation doit avoir un accès READ_DATA ou WRITE_DAC au fichier dont la clé de transfert doit être obtenue, sinon CfGetTransferKey échoue avec HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED).
TransferKey est valide tant que le FileHandle utilisé pour l’obtenir reste ouvert. Le fournisseur de synchronisation doit passer la clé de transfert à CfExecute pour effectuer l’opération souhaitée sur le fichier ou le dossier d’espace réservé. Lorsqu’une clé de transfert n’est plus utilisée, elle doit être publiée à l’aide de CfReleaseTransferKey.
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 |