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 |
Library | CldApi.lib |
[DLL] | CldApi.dll |