Microsoft DirectX 8.0 (C++)

IDirectPlay8Address::GetUserData

アドレス オブジェクトのユーザー データを取得する。このアドレス オブジェクトにユーザー データが存在しない場合、このメソッドは DPNERR_DOESNOTEXIST を返す。

HRESULT GetUserData(
void* pvUserData,
PDWORD pdwBufferSize
);

パラメータ

pvUserData
このアドレスからユーザー データを受け取るバッファへのポインタ。必要なサイズを取得するには、このパラメータに NULL を設定し、pdwBufferSizeDWORD を 0 に設定する。
pdwBufferSize
pvUserData が指すバッファ サイズ (バイト単位)。pvUserData が NULL の場合、このパラメータは 0 を保持する DWORD を示さなければならない。出力では、保持される DWORD はバッファに書き込まれるバイト数に設定される。失敗の場合、ここにはユーザー データの取得に必要なバイト数が保持され、メソッドは DPNERR_BUFFERTOOSMALL を返す。

戻り値

成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。

DPNERR_DOESNOTEXIST
DPNERR_INVALIDPOINTER

動作環境

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