Microsoft DirectX 8.0 (C++)

IDirectPlayVoiceClient::Disconnect

Microsoft® DirectPlay® Voice クライアントを既存の DirectPlay Voice セッションから接続解除する。

HRESULT Disconnect(
DWORD dwFlags
);

パラメータ

dwFlags
フラグ。次のフラグを指定できる。

DVFLAGS_SYNC

処理が完了するまで戻らない。

戻り値

成功した場合は DV_OK を返す。または、次のいずれかのエラー値を返す。

DVERR_ALREADYPENDING
DVERR_CONNECTABORTING
DVERR_INVALIDFLAGS
DVERR_INVALIDPARAM
DVERR_NOTCONNECTED
DVERR_NOTINITIALIZED
DVERR_PENDING
DVERR_SESSIONLOST
DVERR_TIMEOUT

注意

このメソッドを呼び出すと、録音と再生はすべて停止する。処理中の接続は、この呼び出しにより取り消される。

DVFLAGS_SYNC が指定されていない場合、メソッド呼び出し直後に DVERR_PENDING エラー値が返され、バッググラウンドで接続解除要求が処理される。DirectPlay Voice クライアントが接続解除結果を含んだ DVMSG_DISCONNECTRESULT メッセージを生成するまで、接続解除の状態は不明である。一度に 1 つの接続解除のみをペンディング状態にできる。接続解除が保留になっている間に IDirectPlayVoiceClient::Disconnect を呼び出した場合、DirectPlay は DVERR_ALREADYPENDING エラー値を返す。

DVFLAGS_SYNC フラグを設定し、同期をとってこのメソッドを呼び出した場合、Disconnect メソッドが完了するまでこのメソッドは戻らない。接続解除の結果はこのメソッドの戻り値が示す。DVMSGID_DISCONNECTRESULT メッセージは生成されない。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : Dvoice.h で宣言。