Microsoft DirectX 8.0 (C++)

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
DVID of the user or group whose target is returned.
pdvIDTargets
Array of DVIDs that specify 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
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 IDirectPlayVoiceServer::SetTransmitTargets method. If the call is successful, Microsoft® DirectPlay® returns the number of elements in 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

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