Microsoft DirectX 8.0 (C++)

IDirectPlay8Server::SetServerInfo

アプリケーションでサーバーの静的設定を設定する。クライアントがサーバーに正しく接続されると、クライアントは IDirectPlay8Client::GetServerInfo メソッドを呼び出すことにより、このメソッドで設定された情報を取得することができる。

HRESULT SetServerInfo(
const DPN_PLAYER_INFO *const pdpnPlayerInfo,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

パラメータ

pdpnPlayerInfo
設定するサーバー情報を保持する DPN_PLAYER_INFO 構造体へのポインタ。
pvAsyncContext
ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。
phAsyncHandle
DPNHANDLE。値が返される。ただし、Microsoft® DirectPlay® 8.0 ではこの操作の取り消しは許可されていないため、値を使用することはできない。
dwFlags
このメソッドが処理される方法を制御するフラグ。このメソッドには、次のフラグを設定できる。
DPNSETSERVERINFO_SYNC
メソッドを同期をとりながら処理する。

戻り値

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

DPNERR_INVALIDFLAGS
DPNERR_INVALIDPARAM
DPNERR_NOCONNECTION

注意

このメソッドは、IDirectPlayServer::Host を呼び出す前、およびセッション中はいつでも呼び出せる。

IDirectPlay8Server::SetServerInfo メソッドを使用すると処理に負担がかかるため、非静的情報は IDirectPlay8Server::SendTo メソッドを使用して転送すること。

クライアントがアプリケーションに接続した後、このメソッドを使用してサーバー情報を変更できる。接続後にこのメソッドを呼び出すと、データの更新を知らせる DPN_MSGID_SERVER_INFO システム メッセージがすべてのプレーヤーに対して生成される。

動作環境

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