Partager via


structure CF_SYNC_STATUS (cfapi.h)

Utilisé dans une structure de CF_OPERATION_INFO pour décrire la status d’une racine de synchronisation spécifiée.

Syntaxe

typedef struct CF_SYNC_STATUS {
  ULONG StructSize;
  ULONG Code;
  ULONG DescriptionOffset;
  ULONG DescriptionLength;
  ULONG DeviceIdOffset;
  ULONG DeviceIdLength;
} CF_SYNC_STATUS;

Membres

StructSize

Taille, en octets, de la structure de synchronisation status, y compris la chaîne de description réelle.

Code

L’utilisation de ce paramètre revient entièrement au fournisseur de synchronisation qui prend en charge cette construction de synchronisation riche status.

Pour un fournisseur de synchronisation particulier, il est attendu qu’il existe un mappage 1 :1 entre le code et la chaîne de description.

Il est recommandé d’utiliser l’ordre de bits le plus élevé pour décrire le type de code d’erreur : 1 pour un code de niveau erreur et 0 pour un code au niveau des informations.

Notes

Le code est opaque pour la plateforme et est utilisé uniquement à des fins de suivi.

DescriptionOffset

Décalage de la chaîne de description par rapport au début de CF_SYNC_STATUS. Il pointe vers une chaîne large localisée terminée par un caractère Null qui doit contenir des informations plus significatives et exploitables sur le fichier en question. Les fournisseurs de synchronisation sont censés équilibrer la nécessité de fournir des informations plus exploitables et de maintenir un encombrement mémoire aussi petit que possible.

DescriptionLength

Taille de la chaîne de description, en octets, qui inclut la marque de fin Null.

DeviceIdOffset

Décalage d’un objet blob d’ID d’appareil par rapport au début de CF_SYNC_STATUS. L’objet blob id d’appareil est facultatif et opaque pour la plateforme. L’objet blob est censé être unique par appareil. S’il est fourni, l’objet blob est collecté dans le cadre de la télémétrie de la plateforme pour faciliter le diagnostic des problèmes techniques.

DeviceIdLength

Taille de l’objet blob d’ID d’appareil, en octets.

Remarques

Si un pointeur Null est défini dans le champ SyncStatus d’une structure CF_OPERATION_INFO, la plateforme efface le status de synchronisation précédemment défini, le cas échéant.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 10, version 1803 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2016 (applications de bureau uniquement)
En-tête cfapi.h

Voir aussi

CF_OPERATION_INFO