IDirectDrawPalette::GetEntries

The IDirectDrawPalette::GetEntries method queries palette values from a DirectDrawPalette object.

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

Parameters

dwFlags

Currently not used and must be set to 0.

dwBase

Start of the entries to be retrieved sequentially.

dwNumEntries

Number of palette entries that can fit in the address specified in lpEntries. The colors of the palette entry 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.)

lpEntries

Address of the palette entries. 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 Values

If the method succeeds, the return value is DD_OK.

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

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirectDrawPalette::SetEntries