Edit

Share via

IDirectDrawSurface7::GetPrivateData method (ddraw.h)

  • Article

Copies the private data that is associated with this surface to a provided buffer.

Syntax

HRESULT GetPrivateData(
  [in]      REFGUID unnamedParam1,
  [out]     LPVOID  unnamedParam2,
  [in, out] LPDWORD unnamedParam3
);

Parameters

[in] unnamedParam1

Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to be retrieved.

[out] unnamedParam2

A pointer to a previously allocated buffer that receives the requested private data if the call succeeds. The application that calls this method must allocate and release this buffer.

[in, out] unnamedParam3

A pointer to a variable that contains the size value of the buffer at lpBuffer, in bytes. If this value is less than the actual size of the private data (such as 0), GetPrivateData sets the variable to the required buffer size, and then returns DDERR_MOREDATA.

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return one of the following error values:

  • DDERR_EXPIRED
  • DDERR_INVALIDOBJECT
  • DDERR_INVALIDPARAMS
  • DDERR_MOREDATA
  • DDERR_NOTFOUND
  • DDERR_OUTOFMEMORY

Requirements

Requirement Value
Target Platform Windows
Header ddraw.h
Library Ddraw.lib
DLL Ddraw.dll

See also

IDirectDrawSurface7