Platform SDK: DirectX |
DirectPlay4.SetSessionDesc メソッドは、現在のセッションのプロパティを変更する。セッションのプロパティを変更できるのは、セッションのホストだけである。
このメソッドは、ロビー セッションでは使用できない。
object.SetSessionDesc(sessionDesc As DirectPlaySessionData)
失敗すればエラーが発生し、Err.Number に次のいずれかの値が設定される。
DPERR_ACCESSDENIED |
DPERR_CONNECTIONLOST |
DPERR_INVALIDPARAMS |
DPERR_NOSESSIONS |
このコンピュータがセッションを変更する権限を持っていない場合は、DPERR_ACCESSDENIED を返す。アプリケーションが変更できないセッション記述のプロパティを変更しようとした場合や、プロパティに無効な値を設定しようとした場合は、DPERR_INVALIDPARAMS を返す。
更新されたセッション記述は、セッション内のほかのすべてのコンピュータに伝承される。各プレーヤーは、DPSYS_SETSESSIONDESC システム メッセージを受信する。
以下のメソッドを使用して、セッション記述の変更可能な要素を設定することができる。
DPSESSION_JOINDISABLED
DPSESSION_NEWPLAYERSDISABLED
DPSESSION_NODATAMESSAGES
DPSESSION_PRIVATE
DirectPlaySessionData.SetGuidInstance または DirectPlaySessionData.SetGuidApplication を呼び出してオブジェクトのほかのプロパティを変更した場合は、新しい設定は無視される。つまり、DirectPlay は、DirectPlay4.Open が呼び出されたときの値を常に使用する。