Platform SDK: DirectX

DirectPlay4.GetDPEnumGroups

DirectPlay4.GetDPEnumGroups メソッドは、現在のセッション内の最上位グループをすべて列挙する。最上位グループは、DirectPlay4.CreateGroup メソッドを使用して作成されたグループである。

object.GetDPEnumGroups(sessionGuid As String, _
    flags As CONST_DPENUMGROUPFLAGS) _
    As DirectPlayEnumPlayers

パラメータ

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

このフラグには、CONST_DPENUMGROUPFLAGS 列挙型の以下のいずれかの値を設定できる。

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

戻り値

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

エラー コード

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

DPERR_CONNECTIONLOST
DPERR_INVALIDPARAMS
DPERR_NOSESSIONS
DPERR_UNAVAILABLE

このメソッドは、提供された sessionGuid またはフラグが無効な場合は、DPERR_INVALIDPARAMS を返す。開いたセッションが存在しない場合は、DPERR_NOSESSIONS を返す。リモート セッションを列挙できなかった場合は、DPERR_UNAVAILABLE を返す。

注意

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

開いたセッションが存在しない場合は、DPENUMGROUPS_SESSION フラグを指定し、セッションの sessionGuid を指定することにより、リモート セッションのグループを列挙することができる。パスワードで保護されたリモート セッションを列挙することはできない。

グループ内のサブグループを列挙するには、DirectPlay4.GetDPEnumGroupsInGroup を使用する。

参照

DirectPlay4.DestroyGroupDirectPlay4.GetDPEnumSessionsGUID の使用