Platform SDK: DirectX

DirectPlay4.GetDPEnumGroupPlayers

DirectPlay4.GetDPEnumGroupPlayers メソッドは、現在のオープン セッション内で特定のグループに属するプレーヤーを列挙する。

GetDPEnumGroupPlayers(GroupId As Long, _
    sessionGuid As String, _
    flags As CONST_DPENUMPLAYERFLAGS) _
    As DirectPlayEnumPlayers

パラメータ

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

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

DPENUMPLAYERS_LOCAL
DPENUMPLAYERS_OWNER
DPENUMPLAYERS_REMOTE
DPENUMPLAYERS_SERVERPLAYER
DPENUMPLAYERS_SESSION
DPENUMPLAYERS_SPECTATOR

戻り値

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

エラー コード

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

DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDPARAMS
DPERR_INVALIDGROUP
DPERR_NOSESSIONS
DPERR_UNAVAILABLE

このメソッドは、セッションが、接続先ではないロビー セッションの場合は、DPERR_ACCESSDENIED を返す。sessionGuid またはフラグが無効な場合は、DPERR_INVALIDPARAMS を返す。アクティブなセッションが存在しない場合は、DPERR_NOSESSIONS を返す。セッションを列挙できなかった場合は、DPERR_UNAVAILABLE を返す。

注意

パスワードで保護されたリモート セッションは列挙されない。接続していないロビー セッションでこのメソッドを使用することはできない。

このメソッドは、デフォルトでは、現在のセッション内のすべてのプレーヤーを列挙する。セッションのホストが列挙用のリストを提供するように要求するには、DPENUMPLAYERS_SESSION フラグと、セッション インスタンスの GUID を使用する。DPENUMPLAYERS_SESSION フラグをこのメソッドで使用するのは、DirectPlay4.GetDPEnumSessions メソッドを呼び出した後で、なおかつ DirectPlay4.Close メソッドまたは DirectPlay4.Open メソッドを呼び出す前でなければならない。

参照

DirectPlay4.CreatePlayerDirectPlay4.DestroyPlayerDirectPlay4.AddPlayerToGroupDirectPlay4.DeletePlayerFromGroupGUID の使用