IDirectPlayVoiceServer::GetTransmitTargets

Retrieves the transmit targets, if any, of the voice stream for a player in a session.

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

Parameters

dvSource

[in] DVID of the user or group whose target is returned.

pdvIDTargets

[out] Array of DVIDs that will contain the current targets of the player or group that were set by the 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 parameter must be 0.

dwFlags

[in] Reserved. Must be 0.

Return Values

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

Remarks

This method can be used only if the DVSESSION_SERVERCONTROLTARGET flag is specified on creation of the DirectPlay Voice session. If the flag is not specified, this method returns DVERR_NOTALLOWED.

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.