Edit

IDirectDrawPalette::GetEntries method (ddraw.h)

  • Article

Retrieves palette values from a DirectDrawPalette object.

Syntax

HRESULT GetEntries(
  [in]  DWORD          unnamedParam1,
  [in]  DWORD          unnamedParam2,
  [in]  DWORD          unnamedParam3,
  [out] LPPALETTEENTRY unnamedParam4
);

Parameters

[in] unnamedParam1

Currently not used and must be set to 0.

[in] unnamedParam2

Start of the entries to be retrieved sequentially.

[in] unnamedParam3

Number of palette entries that can fit in the array that lpEntries specifies. The colors of the palette entries are returned in sequence, from the value of the dwStartingEntry parameter through the value of the dwCount parameter minus 1. (These parameters are set by IDirectDrawPalette::SetEntries.)

[out] unnamedParam4

An array of PALETTEENTRY structures that receives the palette entries from the DirectDrawPalette object. The palette entries are 1 byte each if the DDPCAPS_8BITENTRIES flag is set, and 4 bytes otherwise. Each field is a color description.

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_INVALIDOBJECT
  • DDERR_INVALIDPARAMS
  • DDERR_NOTPALETTIZED

Requirements

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

See also

IDirectDrawPalette