CfReportSyncStatus-Funktion (cfapi.h)

  • Artikel

Ermöglicht einem Synchronisierungsanbieter, die Plattform über seine status in einem angegebenen Synchronisierungsstamm zu benachrichtigen, ohne zuerst eine Verbindung mit einem Aufruf von CfConnectSyncRoot herstellen zu müssen.

Syntax

HRESULT CfReportSyncStatus(
  [in, out] LPCWSTR        SyncRootPath,
  [in]      CF_SYNC_STATUS *SyncStatus
);

Parameter

[in, out] SyncRootPath

Pfad zum Synchronisierungsstamm.

[in] SyncStatus

Die zu meldende Synchronisierung status; wenn NULL, löscht die zuvor gespeicherte Synchronisierung status. Weitere Informationen finden Sie weiter unten im Abschnitt Hinweise .

Rückgabewert

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

Hinweise

Wenn im SyncStatus-Parameter ein nicht NULL-CF_SYNC_STATUS angegeben wird, werden die Informationen im Synchronisierungsstamm gespeichert, bis sie vom Synchronisierungsanbieter explizit gelöscht werden oder wenn der Computer neu gestartet wird. Die Plattform fragt diese Informationen bei fehlgeschlagenen Vorgängen für einen Clouddateiplatzhalter mit dem folgenden Prozess ab:

  1. Die Plattform sucht zunächst nach Synchronisierung status auf Dateiebene.
  2. Wenn keine Synchronisierungs-status gefunden wird, sucht die Plattform nach der Synchronisierung status, die auf der Synchronisierungsstammebene registriert sind, was über diese Funktion erfolgt.
  3. Sobald eine Synchronisierung status gefunden wurde, verwendet die Plattform die bereitgestellten Informationen, um eine aussagekräftigere und verwertbarere Nachricht für den Benutzer zu erstellen.

CfReportSyncStatus löscht die zuvor gespeicherte Synchronisierungs-status, wenn mit einem Synchronisierungs-status NULL aufgerufen wird. Es wird keine Änderung am vorhandenen Synchronisierungs-status vorgenommen, wenn der Funktionsaufruf fehlschlägt.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 10, Version 1803 [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

CfConnectSyncRoot

CF_SYNC_STATUS