|Microsoft DirectX 9.0|
Disconnects the Microsoft?DirectPlay?Voice client from the existing DirectPlay Voice session.
DWORD dwFlags );
- [in] Flag. You can specify the following flag.
- Do not return until the operation is completed.
Returns DV_OK if successful, or one of the following error values.
DVERR_ALREADYPENDING An asynchronous call of this type is already pending. DVERR_CONNECTABORTING The connection is being disconnected. DVERR_INVALIDFLAGS The flags passed to this method are invalid. DVERR_INVALIDPARAM One or more of the parameters passed to the method are invalid. DVERR_NOTCONNECTED The DirectPlay Voice object is not connected. DVERR_NOTINITIALIZED The IDirectPlayVoiceClient::Initialize or IDirectPlayVoiceServer::Initialize method must be called before calling this method. DVERR_PENDING Not an error, this return indicates that an asynchronous operation has reached the point where it is successfully queued. DVERR_SESSIONLOST The transport has lost the connection to the session. DVERR_TIMEOUT The operation could not be performed in the specified time.
On calling this method, all recording and playback is stopped. If a connection is being processed, it is canceled by this call.
Unless the DVFLAGS_SYNC is specified, calling this method immediately returns a DVERR_PENDING error value and proceeds to process the disconnection request in the background. The status of the disconnection is not known until the DirectPlay Voice client generates a DVMSGID_DISCONNECTRESULT message that contains the disconnection result. Only one disconnection can be pending at a time. If you call IDirectPlayVoiceClient::Disconnect while a disconnect is pending, DirectPlay will return a DVERR_ALREADYPENDING error value.
If this method is called synchronously by setting the DVFLAGS_SYNC flag, the method does not return until the IDirectPlayVoiceClient::Disconnect method completes. The result of the disconnection is the return value from this method. No DVMSGID_DISCONNECTRESULT message is generated.