IDirectPlay8Peer::SetGroupInfo メソッド
IDirectPlay8Peer::SetGroupInfo メソッド
グループ名など、グループに関連付けられているデータ ブロックを設定する。
このメソッドを呼び出すと、DPN_MSGID_GROUP_INFO メッセージが生成される。このメッセージは、アプリケーションに接続されているすべてのピアに送信される。
構文
HRESULT SetGroupInfo(
const DPNID dpnid,
DPN_GROUP_INFO *const pdpnGroupInfo,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);
パラメータ
- dpnid
[in] データ ブロックを変更するグループの識別子を指定する DPNID 型の変数。 - pdpnGroupInfo
[in] 設定するグループ データを記述する DPN_GROUP_INFO 構造体へのポインタ。pwszName メンバまたは pvData メンバの値を変更するには、対応する DPNINFO_NAME フラグまたは DPNINFO_DATA フラグを dwInfoFlags メンバを設定する必要がある。 - pvAsyncContext
[in] ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。 - phAsyncHandle
[out] DPNHANDLE。値が返される。ただし、Microsoft® DirectPlay® ではこの操作の取り消しは許可されていないため、値を使うことはできない。 - dwFlags
[in] このメソッドが処理される方法を制御するフラグ。このメソッドには次のフラグを設定できる。DPNSETGROUPINFO_SYNC
メソッドを同期をとりながら処理する。
戻り値
メソッドが同期をとりながら処理され、処理が成功した場合は S_OK を返す。デフォルトでは、このメソッドは非同期に実行され、通常の場合、DPNSUCCESS_PENDING を返す。また、次のいずれかのエラー値を返す場合もある。
DPNERR_INVALIDFLAGS | このメソッドに渡されたフラグは無効である。 |
DPNERR_INVALIDGROUP | グループ ID が、このゲーム セッションに対する有効なグループ ID として認識されていない。 |
注意
IDirectPlay8Peer::SetGroupInfo メソッドを使うと処理に負担がかかるため、非静的情報は IDirectPlay8Peer::SendTo メソッドを使って転送すること。