以前に登録した同期ルートの登録を解除します。
構文
HRESULT CfUnregisterSyncRoot(
[in] LPCWSTR SyncRootPath
);
パラメーター
[in] SyncRootPath
登録解除する同期ルートへのパス。
戻り値
この関数が成功すると、 が返されます S_OK。 それ以外の場合は、 HRESULT エラー コードが返されます。
注釈
CfRegisterSyncRoot に登録された同期ルートの登録を解除します。 これは通常、同期プロバイダーのアンインストール時、ユーザー アカウントが削除されたとき、またはユーザーがディレクトリ ツリーを同期しないことを選択した場合 (同期プロバイダーでサポートされている場合) に呼び出されます。 登録解除する同期ルートが登録されていない場合、API は STATUS_CLOUD_FILE_NOT_UNDER_SYNC_ROOT で失敗します。
同期プロバイダーには、登録解除する同期ルートへの WRITE_DATA または WRITE_DAC アクセス権が必要です。または、登録解除が HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED) で失敗します。 同期プロバイダーが同期ルートに接続されている場合、登録解除は HRESULT(ERROR_CLOUD_FILE_INVALID_REQUEST) でも失敗します。
同期ルートのディレクトリ ツリーを走査して、同期ルートの登録を解除します。
プレースホルダー ファイルの場合:
- プレースホルダー ファイルが完全にハイドレートされている場合は、"通常" のファイルに戻されます。
- プレースホルダー ファイルがハイドレートされない場合、ローカル コンピューターから完全に削除されます。
プレースホルダー ディレクトリの場合:
- プレースホルダー ディレクトリが完全に設定されている場合は、"通常" のディレクトリに戻されます。
- プレースホルダー ディレクトリが完全に設定されていない場合、ディレクトリはローカル コンピューターから完全に削除されます。
注意
プレースホルダー ファイルまたはディレクトリを元に戻したり削除したりできない場合はスキップされ、完全同期ルート ツリーが走査されるまで、登録解除プロセスが続行されます。
要件
| サポートされている最小のクライアント | Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2016 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | cfapi.h |
| Library | CldApi.lib |
| [DLL] | CldApi.dll |