Microsoft DirectX 8.0 (C++)

IDirectPlayVoiceClient::GetTransmitTargets

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

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

Parameters

pdvIDTargets
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
Number of DVIDs in the array. When you call this method, this should be the same value as the number of targets set in the IDirectPlayVoiceClient::SetTransmitTargets method. If the call is successful, Microsoft® DirectPlay® returns the number of elements written to the pdvIDTargets array.

If pdvIDTargets is NULL, this must be 0.

dwFlags
Reserved. Must be 0.

Return Values

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

DVERR_BUFfERTOOSMALL
DVERR_INVALIDFLAGS
DVERR_INVALIDPARAM
DVERR_INVALIDPOINTER
DVERR_NOTALLOWED
DVERR_NOTCONNECTED
DVERR_NOTINITIALIZED

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_INVALIDPOINTER 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.

Requirements

  Windows NT/2000: Available as a redistributable for Windows 2000 and later.
  Windows 95/98: Available as a redistributable for Windows 95 and later.
  Header: Declared in Dvoice.h.