IDirectPlayVoiceClient::GetTransmitTargets Method

Retrieves the transmit targets, if any, of the voice stream from this client.

Syntax

HRESULT GetTransmitTargets(      
    PDVID pdvIDTargets,
    PDWORD pdwNumTargets,
    DWORD dwFlags
);

Parameters

pdvIDTargets

[out] Member to fill with an array of DVIDs that specify the targets that were set by the IDirectPlayVoiceClient::SetTransmitTargets or IDirectPlayVoiceServer::SetTransmitTargets method. You can retrieve the number of targets by specifying NULL for this parameter.

pdwNumTargets

[in, out] Number of DVIDs in the pdvIDTargets array. If the call is successful, when the method return, this parameter will be set to the number of elements in the pdvIDTargets array. If the array is too small, the method returns DVERR_BUFFERTOOSMALL, and pdwNumTargets will be set to the required number of elements. If pdvIDTargets is NULL, this must be 0.

dwFlags

[in] Reserved. Must be 0.

Return Value

Returns DV_OK if successful, or one of the following error values.

DVERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.
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_INVALIDPOINTER	The pointer specified is invalid.
DVERR_NOTALLOWED	The object does not have the permission to perform this operation.
DVERR_NOTCONNECTED	The Microsoft® DirectPlay® Voice object is not connected.
DVERR_NOTINITIALIZED	The IDirectPlayVoiceClient::Initialize or IDirectPlayVoiceServer::Initialize method must be called before calling this method.

Remarks

The value returned in the pdvIDTargets parameter can be player or group DVIDs or the DVID_ALLPLAYERS constant.

If the buffer specified in pdvIDTargets is not large enough to store the list of targets, this method returns DVERR_BUFFERTOOSMALL and pdwNumTargets is set to the required number of elements.

If there is no target specified, pdwNumTargets is set to 0 and the return value is DV_OK.