cfReportSyncStatus 函式 (cfapi.h)
允許同步提供者在指定的同步根目錄上通知平臺其狀態,而不需要先呼叫 CfConnectSyncRoot 。
語法
HRESULT CfReportSyncStatus(
[in, out] LPCWSTR SyncRootPath,
[in] CF_SYNC_STATUS *SyncStatus
);
參數
[in, out] SyncRootPath
同步根目錄的路徑。
[in] SyncStatus
要報告的同步處理狀態;如果 NULL
為 ,則會清除先前儲存的同步處理狀態。 如需詳細資訊,請參閱下面的一節。
傳回值
如果函式成功,則會傳 S_OK
回 。 否則,它會傳回 HRESULT 錯誤碼。
備註
在 SyncStatus 參數中提供非 Null CF_SYNC_STATUS時,在同步根目錄上會記住資訊,直到同步提供者明確清除或電腦重新啟動為止。 平臺會使用下列程式,查詢雲端檔案佔位元上任何失敗作業的相關信息:
- 平臺會先在檔案層級搜尋同步處理狀態。
- 如果找不到同步處理狀態,則平臺會搜尋在同步根層級註冊的同步處理狀態,這是透過此函式完成的。
- 一旦找到同步處理狀態,平臺就會使用提供的資訊來建構更有意義的且可採取動作的訊息給使用者。
CfReportSyncStatus 會在以同步狀態呼叫時清除先前儲存的 NULL
同步處理狀態。 如果函數調用失敗,則不會變更現有的同步處理狀態。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 10 1803 版 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2016 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | cfapi.h |
程式庫 | CldApi.lib |
Dll | CldApi.dll |