Platform SDK: DirectX

DirectPlay4.GetDPEnumPlayers

DirectPlay4.GetDPEnumPlayers メソッドは、現在開いているセッション内のプレーヤーを列挙し、オプションでグループも列挙する。開いたセッションが存在しない場合は、リモート セッション内のプレーヤーを列挙できる。

object.GetDPEnumPlayers(sessionGuid As String, _
    flags As CONST_DPENUMPLAYERFLAGS) _
    As DirectPlayEnumPlayers

パラメータ

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

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

DPENUMPLAYERS_ALL
DPENUMPLAYERS_GROUP
DPENUMPLAYERS_LOCAL
DPENUMPLAYERS_REMOTE
DPENUMPLAYERS_SERVERPLAYER
DPENUMPLAYERS_SESSION
DPENUMPLAYERS_SPECTATOR

戻り値

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

エラー コード

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

DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDPARAMS
DPERR_NOSESSIONS
DPERR_UNAVAILABLE

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

このメソッドは、ロビー セッション内では、常に DPERR_ACCESSDENIED を返す。

注意

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

参照

DirectPlay4.CreatePlayerDirectPlay4.DestroyPlayerGUID の使用