Platform SDK: DirectX

DirectPlay4.GetPlayerData

DirectPlay4.GetPlayerData メソッドは、DirectPlay4.SetPlayerData によってプレーヤー ID に関連付けられた、アプリケーション固有のデータ ブロックを所得する。

object.GetPlayerData(playerId As Long, _
    flags As CONST_DPGETFLAGS) As String

パラメータ

object
DirectPlay4 オブジェクトを表すオブジェクト式。
playerId
データを要求するプレーヤーの ID。
flags
取得するプレーヤー データのタイプ (ローカルまたはリモート) を示す、CONST_DPGETFLAGS 列挙型の値。このパラメータに 0 を設定すると、リモート データが取得される。

戻り値

アプリケーション定義のデータを含む文字列を返す。

エラー コード

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

DPERR_BUFFERTOOSMALL
DPERR_INVALIDFLAGS
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER

注意

ローカル データは、現在の DirectPlay オブジェクトにより、DirectPlay4.SetPlayerData で DPSET_LOCAL フラグを使用して設定されている。リモート データは、セッション内の任意のアプリケーションにより、DPSET_REMOTE フラグを使用して設定された可能性がある。