Fonction CfGetPlaceholderInfo (cfapi.h)

Article
04/06/2023

Obtient les différentes caractéristiques d’un fichier ou dossier d’espace réservé. Si le fichier n’est pas un espace réservé 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.

Syntaxe

HRESULT CfGetPlaceholderInfo(
  [in]            HANDLE                    FileHandle,
  [in]            CF_PLACEHOLDER_INFO_CLASS InfoClass,
  [out]           PVOID                     InfoBuffer,
  [in]            DWORD                     InfoBufferLength,
  [out, optional] PDWORD                    ReturnedLength
);

Paramètres

[in] FileHandle

Handle de l’espace réservé dont les informations seront interrogées. Contrairement à la plupart des API de fichiers cloud qui prennent un handle de fichier, celui-ci ne modifie pas le fichier de quelque manière que ce soit. Par conséquent, le handle de fichier nécessite uniquement un accès READ_ATTRIBUTES .

[in] InfoClass

Informations d’espace réservé. Cette valeur peut être définie sur CF_PLACEHOLDER_STANDARD_INFO ou CF_PLACEHOLDER_BASIC_INFO.

[out] InfoBuffer

Pointeur vers une mémoire tampon qui recevra des informations sur l’espace réservé.

[in] InfoBufferLength

Longueur d’InfoBuffer, en octets. Si la mémoire tampon n’est pas assez grande pour contenir toutes les informations demandées, l’API retourne autant de données qu’elle peut tenir dans la mémoire tampon, et l’appel échoue avec HRESULT_FROM_WIN32(ERROR_MORE_DATA) .

[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

Les informations d’espace réservé incluent les attributs suivants :

Attribut	Description
OnDiskDataSize	Nombre total d’octets sur le disque.
ValidatedDataSize	Nombre total d’octets synchronisés avec le cloud.
ModifiedDataSize	Nombre total d’octets qui ont été remplacés/ajoutés localement, c’est-à-dire non synchronisés avec le cloud.
PropriétésSize	Nombre total d’octets sur le disque utilisé par tous les objets blob de propriété.
PinState	Pour plus d’informations, reportez-vous à CfSetPinState .
InSyncState	Pour plus d’informations, reportez-vous à CfSetInSyncState .
FileId	Nombre non volatile de volume 64 bits qui identifie de manière unique un fichier ou un répertoire.
SyncRootFileId	ID de fichier du répertoire racine de synchronisation sous lequel réside le fichier dont les informations d’espace réservé doivent être interrogées.
FileIdentity	Objet blob opaque fourni par le fournisseur de synchronisation à la plateforme lors de la création de l’espace réservé. L’identité de fichier est fournie pour tous les rappels du fournisseur de synchronisation.
FileIdentityLength	Longueur de l’identité de fichier en octets.

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

CfSetPinState

CfSetInSyncState

CF_PLACEHOLDER_STANDARD_INFO

CF_PLACEHOLDER_BASIC_INFO

Partager via