Platform SDK: DirectX

DirectPlayLobby3.ReceiveLobbyMessage

DirectPlayLobby3.ReceiveLobbyMessage メソッドは、ロビー クライアント アプリケーションと DirectPlay アプリケーションの間で送信されるメッセージを取得する。メッセージはキューに入れられるので、時間内に読めなくても、データを失う危険はない。

object.ReceiveLobbyMessage(applicationId As Long, _
    messageFlags As Long) As DirectPlayMessage 

パラメータ

object
DirectPlayLobby3 オブジェクトを表すオブジェクト式。
applicationId
メッセージを受信するアプリケーションの識別子。(複数のアプリケーションと通信する) ロビー クライアントから呼び出される場合、この ID 番号は、DirectPlayLobby3.RunApplication メソッドにより取得されるもののいずれかになる。(1 つのロビー クライアントのみと通信する) アプリケーションから呼び出される場合、このパラメータには 0 を設定する必要がある。
messageFlags
返されるメッセージのタイプを示す、CONST_DPLMSG 列挙型のフラグ。デフォルト (messageFlags = 0 または DPLMSG_USERDEFINED) は、メッセージが送信側によって独自に定義されたものであることを示す。この種のメッセージの処理はオプションである。受信側は、このメッセージを、送信側のアプリケーションの身元に応じて解釈する必要がある。ロビーは、起動されたアプリケーションの GUID に応じて、送信側のアプリケーションを識別することができる。アプリケーションは、識別用の GUID を要求する標準のメッセージを送信することにより、ロビーを識別する必要がある。

戻り値

成功すれば、DirectPlayMessage オブジェクトを返す。このオブジェクトのメソッドを使用して、メッセージのデータを取り出すことができる。保留中のメッセージが存在しない場合は、Nothing を返す。

エラー コード

失敗すればエラーが発生し、Err.Number に次のいずれかの値が設定される。

DPERR_APPNOTSTARTED
DPERR_GENERIC
DPERR_INVALIDINTERFACE
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_OUTOFMEMORY

参照

DirectPlayLobby3.SendLobbyMessage