IDirectPlayVoiceClient::GetTransmitTargets メソッド

IDirectPlayVoiceClient::GetTransmitTargets メソッド

このクライアントからの音声ストリームの送信ターゲットを取得する (存在する場合)。

構文

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

パラメータ

• pdvIDTargets
  [out] IDirectPlayVoiceClient::SetTransmitTargets メソッドまたは IDirectPlayVoiceServer::SetTransmitTargets メソッドにより設定されたターゲットを指定する DVID の配列を格納するメンバ。このパラメータに NULL を指定して、ターゲットの数を取得することができる。
• pdwNumTargets
  [in, out] pdvIDTargets 配列内の .DVID の数。呼び出しが成功すると、メソッドが戻るとき、このパラメータは pdvIDTargets 配列の要素の数に設定される。配列が小さすぎると、メソッドは DVERR_BUFFERTOOSMALL を返し、pdwNumTargets は必要な要素の数に設定される。pdvIDTargets が NULL である場合、0 に設定しておく。
• dwFlags
  [in] 予約済み。0 でなければならない。

戻り値

成功した場合は DV_OK を返す。または、次のいずれかのエラー値を返す。

DVERR_BUFFERTOOSMALL	指定されたバッファが小さすぎて、要求されたデータを格納できない。
DVERR_INVALIDFLAGS	このメソッドに渡されたフラグは無効である。
DVERR_INVALIDPARAM	メソッドに渡された 1 つ以上のパラメータが無効である。
DVERR_INVALIDPOINTER	指定されたポインタが無効である。
DVERR_NOTALLOWED	オブジェクトには、この処理を実行する権限がない。
DVERR_NOTCONNECTED	Microsoft® DirectPlay® Voice オブジェクトが接続されていない。
DVERR_NOTINITIALIZED	このメソッドを呼び出す前に、IDirectPlayVoiceClient::Initialize メソッドまたは IDirectPlayVoiceServer::Initialize メソッドを呼び出す必要がある。

注意

pdvIDTargets パラメータに返される値は、プレーヤ DVID かグループ DVID、または定数 DVID_ALLPLAYERS である。

pdvIDTargets に指定されたバッファが小さく、ターゲットのリストが格納できない場合、このメソッドは DVERR_BUFFERTOOSMALL を返し、必要な要素数が pdwNumTargets に設定される。

ターゲットが指定されていない場合、pdwNumTargets は 0 に設定され、戻り値は DV_OK になる。