EnumPlayersCallback2
EnumPlayersCallback2 は、アプリケーションにより定義されたコールバック関数である。アプリケーションでは、この関数を実装して、IDirectPlay4::EnumGroups メソッド、IDirectPlay4::EnumGroupPlayers メソッド、IDirectPlay4::EnumPlayers メソッド、および IDirectPlay4::EnumGroupsInGroup メソッドに関数へのポインタを渡す必要がある。このコールバック関数は、列挙されるプレーヤーまたはグループごとに 1 回ずつ呼び出される。
BOOL FAR PASCAL EnumPlayersCallback2(
DPID dpId,
DWORD dwPlayerType,
LPCDPNAME lpName,
DWORD dwFlags,
LPVOID lpContext
);
パラメータ
- dpId
- 列挙するプレーヤーまたはグループの ID。
- dwPlayerType
- DPPLAYERTYPE_GROUP または DPPLAYERTYPE_PLAYER のいずれかのエンティティのタイプ。
- lpName
- プレーヤーまたはグループの名前が格納されている DPNAME 構造体への読み取り専用ポインタ。このポインタは、コールバック関数の処理中にのみ有効である。後から参照するためにデータを保存するときは、それをアプリケーションが所有しているメモリにコピーする必要がある。
- dwFlags
- 列挙するグループやプレーヤーを記述したフラグ。
- DPENUMGROUPS_HIDDEN
- グループは、隠しフラグを使用して作成された。
- DPENUMGROUPS_SHORTCUT
- グループは、ショートカットである。
- DPENUMGROUPS_STAGINGAREA
- グループは、ステージング領域である。
- DPENUMPLAYERS_GROUP
- プレーヤーとグループの両方が列挙されている。このフラグは、このコールバック関数の呼び出し元の列挙メソッドでそれが指定されていた場合にのみ返される。
- DPENUMPLAYERS_LOCAL
- プレーヤーまたはグループはローカル コンピュータ上に存在する。このフラグは、このコールバック関数の呼び出し元の列挙メソッドでそれが指定されていた場合にのみ返される。
- DPENUMPLAYERS_OWNER
- プレーヤーは、グループの所有者である。このコールバック関数の呼び出し元の IDirectPlay4::EnumGroupPlayers メソッドでそれが指定されていた場合にのみ返される。
- DPENUMPLAYERS_REMOTE
- プレーヤーやグループは、リモート コンピュータ上に存在する。このフラグは、このコールバック関数の呼び出し元の列挙メソッドでそれが指定されていた場合にのみ返される。
- DPENUMPLAYERS_SERVERPLAYER
- プレーヤーは、アプリケーション/サーバー セッションのサーバー プレーヤーである。各セッションにサーバー プレーヤーは 1 つしか存在しない。
- DPENUMPLAYERS_SESSION
- プレーヤーやグループは、列挙メソッドの lpguidInstance により指定されたセッションに存在する。このフラグは、このコールバック関数の呼び出し元の列挙メソッドでそれが指定されていた場合にのみ返される。
- DPENUMPLAYERS_SPECTATOR
- プレーヤーは、観客である (プレーヤーにのみ適用される)。
- lpContext
- アプリケーションにより定義されたコンテキストへのポインタ。
戻り値
列挙を継続する場合は、TRUE を返す。列挙を停止する場合は、FALSE を返す。
注意
コールバック関数で返されるポインタは一時的なものであり、コールバック関数の内部でのみ有効である。アプリケーションは、ポインタ情報を保存する必要がある場合、データを保持するためのメモリを割り当て、データをコピーしてから、この新しいデータへのポインタを保存する必要がある。
Windows NT/2000 : Windows 2000 が必要。
Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
ヘッダー : dplay.h で宣言。
参照
DPNAME、IDirectPlay4::EnumGroups、IDirectPlay4::EnumPlayers、IDirectPlay4::EnumGroupPlayers、IDirectPlay4::EnumGroupsInGroup