CfDisconnectSyncRoot 関数 (cfapi.h)
CfConnectSyncRoot によって作成された通信チャネルを切断します。
構文
HRESULT CfDisconnectSyncRoot(
[in] CF_CONNECTION_KEY ConnectionKey
);
パラメーター
[in] ConnectionKey
CfConnectSyncRoot から返された接続キー。同期ルートの切断に使用されます。
戻り値
この関数が成功すると、 が返されます S_OK
。 そうでない場合は、HRESULT エラー コードを返します。
注釈
これにより、 CfConnectSyncRoot を使用して以前に確立されたプラットフォームとの通信チャネルが削除されます。
同期プロバイダーは CfDisconnectSyncRoot 呼び出し中にコールバックを受け取ることができ、プロバイダーは呼び出しを失敗させるか、サービスする必要があるかを自由に選択できます。 どちらの選択でも、同期プロバイダーが中断されることはありません。
CfDisconnectSyncRoot の呼び出しが返された後、同期プロバイダーはコールバックを受信しなくなり、プラットフォームは上記のコールバックに依存するすべての操作に失敗します。
同期プロバイダーは、同期ルートへの WRITE_DATA または WRITE_DAC アクセスを切断する必要があります。または 、CFDisconnectSyncRoot の呼び出しが HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED) で失敗します。 また、同期ルートが以前に接続されていない場合、呼び出しは無効なパラメーターで失敗します。 この API は、同期プロバイダーを正常にシャットダウンする一環として呼び出される可能性があります。 ただし、同期プロバイダー プロセスでこの API を呼び出さずに終了することを選択した場合、または予期せずクラッシュした場合、プラットフォームはこれを検出し、必要なクリーンアップを実行します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2016 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | cfapi.h |
Library | CldApi.lib |
[DLL] | CldApi.dll |