Partager via

Fonction CfSetInSyncState (cfapi.h)

  • Article

Définit l’état de synchronisation d’un fichier ou dossier d’espace réservé.

Syntaxe

HRESULT CfSetInSyncState(
  [in]                HANDLE               FileHandle,
  [in]                CF_IN_SYNC_STATE     InSyncState,
  [in]                CF_SET_IN_SYNC_FLAGS InSyncFlags,
  [in, out, optional] USN                  *InSyncUsn
);

Paramètres

[in] FileHandle

Handle de l’espace réservé. La plateforme synchronise correctement l’opération avec d’autres requêtes actives. Un attribut ou un handle sans accès est suffisant. L’appelant doit disposer d’un accès WRITE_DATA ou WRITE_DAC à l’espace réservé.

[in] InSyncState

État synchronisé. InSyncState peut être défini sur l’une des valeurs suivantes :

  • Si CF_IN_SYNC_STATE_NOT_IN_SYNC est spécifié, la plateforme efface l’état synchronisé de l’espace réservé lors d’un retour réussi de l’appel d’API.
  • Si CF_IN_SYNC_STATE_IN_SYNC est spécifié, la plateforme définit l’état synchronisé de l’espace réservé en cas de retour réussi de l’appel d’API.

[in] InSyncFlags

Indicateurs d’état synchronisés. Pour plus d’informations, consultez CF_SET_IN_SYNC_FLAGS .

[in, out, optional] InSyncUsn

Lorsqu’il est spécifié, lors de l’entrée, InSyncUsn indique à la plateforme d’effectuer uniquement le paramètre de synchronisation si le fichier a toujours la même valeur USN que celle transmise. Il s’agit de fermer une course où l’espace réservé du fournisseur de synchronisation vient de se synchroniser jusqu’au cloud, mais avant l’appel à CfSetInSyncState, l’espace réservé a changé d’une manière ou d’une autre. Passer un pointeur vers une valeur USN de 0 sur entrée est identique à passer un NULL pointeur. En retour, InSYncUsn reçoit la valeur USN finale après avoir défini l’état synchronisé.

Valeur retournée

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

Spécifications

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

CF_IN_SYNC_STATE

CF_SET_IN_SYNC_FLAGS