IDirectPlay8Address::GetUserData メソッド

IDirectPlay8Address::GetUserData メソッド

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

構文

HRESULT GetUserData(      
    void *pvUserData,
    PDWORD pdwBufferSize
);

パラメータ

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

戻り値

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

DPNERR_DOESNOTEXIST	要求された要素はアドレスの一部ではない。
DPNERR_INVALIDPOINTER	パラメータとして指定されたポインタが無効である。
DPNERR_BUFFERTOOSMALL	指定されたバッファが小さすぎて、要求されたデータを格納できない。