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

[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 returns, 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 Values

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

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.

Requirements

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