Platform SDK: DirectX

DirectPlay4.GetDPEnumGroupsInGroup

DirectPlay4.GetDPEnumGroupsInGroup メソッドは、別のグループに含まれているグループおよびグループへのショートカットをすべて列挙する。グループを DirectPlay4.CreateGroupInGroup メソッドによって作成するか、または DirectPlay4.AddGroupToGroup メソッドによって別のグループに追加すると、そのグループは別のグループの内部に配置される。このメソッドは再帰的ではない。

object.GetDPEnumGroupsInGroup(GroupId As Long, _
    sessionGuid As String, _
    flags As CONST_DPENUMGROUPFLAGS) _
    As DirectPlayEnumPlayers

パラメータ

object
DirectPlay4 オブジェクトを表すオブジェクト式。
GroupId
列挙するサブグループが属するグループの ID。
sessionGuid
列挙するセッションのグローバル ユニーク識別子 (GUID)。DPENUMPLAYERS_SESSION フラグが設定されている場合を除き、このパラメータは無視される。この GUID は、DirectPlay4.GetDPEnumSessions メソッドによって列挙されるセッションのいずれかと等しくなければならない。
flags
列挙の方法を指定するフラグ。デフォルト (flags = 0) では、現在のアクティブなセッション内のグループをすべて列挙する。組み合わせられたフラグのすべての条件に一致するグループだけが、列挙される。たとえば、(DPENUMGROUPS_LOCAL Or DPENUMGROUPS_STAGINGAREA) と指定すると、ローカルで、なおかつステージング領域であるグループだけが列挙される。(DPENUMGROUPS_LOCAL Or DPENUMGROUPS_REMOTE) と指定すると、ローカルで、なおかつリモートなグループは存在しないため、グループは列挙されない。

このフラグには、CONST_DPENUMGROUPFLAGS 列挙型の以下の 1 つ以上の値を設定できる。

DPENUMGROUPS_ALL
グループ内のすべてのグループを列挙する。
DPENUMGROUPS_HIDDEN
グループ内の現在利用可能な隠れたグループのみを列挙する。
DPENUMGROUPS_LOCAL
この DirectPlay オブジェクトによってローカルに作成されたグループ内のグループのみを列挙する。
DPENUMGROUPS_REMOTE
リモートの DirectPlay オブジェクトによって作成されたグループ内のグループのみを列挙する。
DPENUMGROUPS_SESSION
sessionGuid パラメータによって指定されるセッション内で列挙を実行する。このフラグは、現在アクティブなセッションが存在しない場合にのみ使用できる。このフラグをロビー セッションで使用することはできない。
DPENUMGROUPS_SHORTCUT
DirectPlay4.AddGroupToGroup を使用してグループに追加されたショートカットであるグループを列挙する (ショートカットは、別のグループへのリンクである)。
DPENUMGROUPS_STAGINGAREA
ステージング領域であるグループ内のグループを列挙する (ステージング領域は、新しいセッションを開始する際に、プレーヤーを配置するために利用される)。

戻り値

成功すれば、DirectPlayEnumPlayers オブジェクトを返す。

エラー コード

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

DPERR_CONNECTIONLOST
DPERR_INVALIDFLAGS
DPERR_INVALIDGROUP
DPERR_INVALIDPARAMS
DPERR_NOSESSIONS
DPERR_UNSUPPORTED

このメソッドは、渡された sessionGuid が無効の場合は、DPERR_INVALIDPARAMS を返す。アクティブなセッションが存在しない場合は、DPERR_NOSESSIONS を返す。セッションを列挙できなかった場合は、DPERR_UNSUPPORTED を返す。

注意

このメソッドを、接続していないロビー セッションで使用することはできない。

参照

DirectPlay4.DeleteGroupFromGroupDirectPlay4.DestroyGroupGUID の使用