Microsoft DirectX 8.0 (C++)

IDirectPlay8Server::AddPlayerToGroup

グループにクライアントを追加する。クライアントがグループに正しく追加された後、グループに送信されるすべてのメッセージがクライアントに送信される。

HRESULT AddPlayerToGroup(
const DPNID idGroup,
const DPNID idClient,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

パラメータ

idGroup
グループに追加するクライアントの識別子を指定する DPNID 型の変数。
idClient
グループに追加するクライアントの識別子を指定する DPNID 型の変数。
pvAsyncContext
ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。このパラメータはオプションであり、NULL に設定できる。
phAsyncHandle
DPNHANDLE。値が返される。ただし、Microsoft® DirectPlay® 8.0 ではこの操作の取り消しは許可されていないため、値を使用することはできない。
dwFlags
このメソッドが処理される方法を制御するフラグ。このメソッドには、次のフラグを設定できる。
DPNADDPLAYERTOGROUP_SYNC
メソッドを同期をとりながら処理する。

戻り値

メソッドが同期をとりながら処理され、処理が成功した場合は S_OK を返す。デフォルトでは、このメソッドは非同期に実行され、通常は DPNSUCCESS_PENDING か、または次のいずれかのエラー値を返す。

DPNERR_INVALIDFLAGS
DPNERR_INVALIDGROUP
DPNERR_INVALIDPLAYER

注意

サーバーは、サーバー自体またはクライアントを既存のグループに追加できる。プレーヤーがグループに正しく追加されると、グループに送られたすべてのメッセージをプレーヤーも受け取る。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : Dplay8.h で宣言。