Platform SDK: DirectX

DirectPlay4.GetGroupData

DirectPlay4.GetGroupData メソッドは、グループに関連付けられた、アプリケーションに固有の文字列を取得する。

object.GetGroupData(GroupId As Long, _
    flags As CONST_DPGETFLAGS) As String 

パラメータ

object
DirectPlay4 オブジェクトを表すオブジェクト式。
GroupId
データを要求するグループの ID。
flags
CONST_DPGETFLAGS 列挙型の値で、取得するグループ データのタイプ (ローカルまたはリモート) を示す。このパラメータを 0 に設定すると、リモート データが取得される。

戻り値

成功すれば、DirectPlay4.SetGroupData メソッドによってグループに関連付けられたデータを含む文字列を返す。

エラー コード

失敗すればエラーが発生し、Err.Number に次のいずれかの値が設定される。

DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

注意

DirectPlay は、ローカルまたはリモートのいずれかのタイプのグループ データを維持することができる。アプリケーションでは、どちらのタイプのデータを取得するのか指定する必要がある。ローカル データは、この DirectPlay オブジェクトにより、DPSET_LOCAL フラグを使用して設定されている。リモート データは、セッション内の任意のアプリケーションにより、DPSET_REMOTE フラグを使用して設定されている。