IDirectPlayVoiceServer::GetTransmitTargets Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlayVoiceServer::GetTransmitTargets Method


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

Syntax

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 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_BUFFERTOOSMALLThe supplied buffer is not large enough to contain the requested data.
DVERR_INVALIDFLAGSThe flags passed to this method are invalid.
DVERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTERThe pointer specified is invalid.
DVERR_NOTALLOWEDThe object does not have the permission to perform this operation.
DVERR_NOTCONNECTEDThe Microsoft® DirectPlay® Voice object is not connected.
DVERR_NOTINITIALIZEDThe IDirectPlayVoiceClient::Initialize or IDirectPlayVoiceServer::Initialize method must be called before calling this method.

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.



© 2003 Microsoft Corporation. All rights reserved.