Platform SDK: DirectX

IDirectDrawSurface7::GetPrivateData

IDirectDrawSurface7::GetPrivateData メソッドは、提供されるバッファへのサーフェスに関連付けられたプライベート データをコピーする。

HRESULT GetPrivateData(
  REFGUID guidTag,
  LPVOID  lpBuffer,
  LPDWORD lpcbBufferSize
); 

パラメータ

guidTag
取得するプライベート データを識別するグローバル ユニーク識別子の (C++) または (C) のアドレスへの参照。
lpBuffer
呼び出しが成功した場合に、要求したプライベート データを格納する割り当て済みバッファのアドレス。このメソッドを呼び出すアプリケーションは、このバッファの割り当てと解放に責任を負う。
lpcbBufferSize
バイト単位の lpBuffer のバッファ サイズ。この値が実際のプライベート データのサイズよりも小さい (0 など) 場合、メソッドは要求されるバッファ サイズにこのパラメータを設定し、DDERR_MOREDATA を返す。

戻り値

成功すれば、DD_OK を返す。

失敗すれば、以下のエラー値のいずれかを返す。

DDERR_EXPIRED
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_MOREDATA
DDERR_NOTFOUND
DDERR_OUTOFMEMORY

動作環境

  Windows NT/2000 :Windows 2000 が必要。
  Windows 95/98 : Windows 98 が必要。
  ヘッダー : ddraw.h で宣言。

参照

IDirectDrawSurface7::SetPrivateDataIDirectDrawSurface7::FreePrivateData