Microsoft DirectX 9.0

IDirectDrawPalette::GetEntries

The GetEntries method queries palette values from a DirectDrawPalette.

Syntax

HRESULT GetEntries(
  DWORD dwFlags,
  DWORD dwBase,
  DWORD dwNumEntries,
  LPPALETTEENTRY lpEntries
  );

Parameters

dwFlags

Not used at this time. Must be zero.

dwBase

This is the start of the entries that should be retrieved sequentially.

dwNumEntries

Number of palette entries in the buffer pointed to by lpEntries.

lpEntries

A pointer to the palette entries. The palette entries are one byte each if the DDPCAPS_8BITENTRIES flag is set in DDCAPS.dwPalCaps, and four bytes otherwise. Each field is a color description.

Return Values

Value Description
DD_OK The method succeeded.
DDERR_INVALIDOBJECT DirectDraw received a pointer that was an invalid DirectDraw object.
DDERR_INVALIDPARAMS One or more of the parameters passed to the function are incorrect.
DDERR_NOTPALETTIZED The surface being used is not a palette-based surface.

See Also