CfReportSyncStatus function (cfapi.h)

Allows a sync provider to notify the platform of its status on a specified sync root without having to connect with a call to CfConnectSyncRoot first.

Syntax

HRESULT CfReportSyncStatus(
  LPCWSTR        SyncRootPath,
  CF_SYNC_STATUS *SyncStatus
);

Parameters

SyncRootPath

Path to the sync root.

SyncStatus

The sync status to report; if null, clears the previously-saved sync status. For more information, see the Remarks section, below.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

When a non-null CF_SYNC_STATUS is provided in the SyncStatus parameter, the information will be remembered on the sync root until it is cleared explicitly by the sync provider or when the machine reboots. The platform will query this information upon any failed operations on a cloud file placeholder, using the following process:

  1. The platform will first search for sync status at the file level.

  2. If no sync status is found, the platform will then search for sync status registered at the sync root level, which is done through this function.

  3. Once a sync status is located, the platform will use the information provided to construct a more meaningful and actionable message to the user.

CfReportSyncStatus clears the previously-saved sync status when being called with a null sync status. No change will be made to the existing sync status if the function call fails.

Requirements

   
Minimum supported client Windows 10, version 1803 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header cfapi.h
Library CldApi.lib
DLL CldApi.dll