CfSetInSyncState-Funktion (cfapi.h)

  • Artikel

Legt den Synchronstatus für eine Platzhalterdatei oder einen Ordner fest.

Syntax

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

Parameter

[in] FileHandle

Ein Handle für den Platzhalter. Die Plattform synchronisiert den Vorgang ordnungsgemäß mit anderen aktiven Anforderungen. Ein Attribut oder kein Zugriffshandle ist ausreichend. Der Aufrufer muss WRITE_DATA oder WRITE_DAC Zugriff auf den Platzhalter haben.

[in] InSyncState

Der synchrone Zustand. InSyncState kann auf einen der folgenden Werte festgelegt werden:

  • Wenn CF_IN_SYNC_STATE_NOT_IN_SYNC angegeben ist, löscht die Plattform den Synchronisierungsstatus des Platzhalters nach erfolgreicher Rückgabe des API-Aufrufs.
  • Wenn CF_IN_SYNC_STATE_IN_SYNC angegeben ist, legt die Plattform den Synchronisierungsstatus des Platzhalters bei erfolgreicher Rückgabe des API-Aufrufs fest.

[in] InSyncFlags

Die In-Sync-Statusflags. Weitere Informationen finden Sie unter CF_SET_IN_SYNC_FLAGS .

[in, out, optional] InSyncUsn

Wenn angegeben, weist InSyncUsn die Plattform bei der Eingabe an, die In-Sync-Einstellung nur dann auszuführen, wenn die Datei noch denselben USN-Wert wie der übergebene aufweist. Dies ist, um ein Race zu schließen, bei dem der Synchronisierungsanbieter gerade den Synchronisierungsplatzhalter bis zur Cloud geändert hat, aber vor dem Aufruf von CfSetInSyncState hat sich der Platzhalter in irgendeiner Weise geändert. Das Übergeben eines Zeigers auf einen USN-Wert von 0 bei eingabe ist mit dem Übergeben eines NULL Zeigers identisch. Bei der Rückgabe empfängt InSYncUsn den endgültigen USN-Wert, nachdem der Synchronstatus festgelegt wurde.

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 10, Version 1709 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2016 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile cfapi.h
Bibliothek CldApi.lib
DLL CldApi.dll

Weitere Informationen

CF_IN_SYNC_STATE

CF_SET_IN_SYNC_FLAGS