Fonction CfGetSyncRootInfoByHandle (cfapi.h)

Obtient différentes caractéristiques de la racine de synchronisation contenant un fichier donné spécifié par un handle de fichier.

Syntaxe

HRESULT CfGetSyncRootInfoByHandle(
  [in]            HANDLE                  FileHandle,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

Paramètres

[in] FileHandle

Gérer le fichier sous la racine de synchronisation dont les informations doivent être interrogées.

[in] InfoClass

Types d’informations racine de synchronisation.

[out] InfoBuffer

Pointeur vers une mémoire tampon qui recevra les informations racine de synchronisation.

[in] InfoBufferLength

Longueur, en octets, de l’InfoBuffer.

[out, optional] ReturnedLength

Nombre d’octets retournés dans InfoBuffer.

Valeur retournée

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

Remarques

Contrairement à la plupart des API d’espace réservé qui prennent un handle de fichier, celui-ci ne modifie pas le fichier de quelque manière que ce soit. Par conséquent, fileHandle nécessite uniquement READ_ATTRIBUTES accès.

Si le fichier ne se trouve pas sous une racine de synchronisation de fichiers cloud, l’API échoue. En cas de réussite, les informations sont retournées en fonction de l’InfoClasse spécifique demandée.

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

Voir aussi

CfGetSyncRootInfoByPath