GetPaletteEntries

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves a specified range of palette entries from the specified logical palette.

Syntax

UINT GetPaletteEntries( 
  HPALETTE hpal, 
  UINT iStartIndex, 
  UINT nEntries, 
  LPPALETTEENTRY lppe
);

Parameters

• hpal
  [in] Handle to the logical color palette.

• iStartIndex
  [in] Index of the first entry in the logical palette to be retrieved. GetPaletteEntries fails if iStartIndex is greater than the number of palette entries.

• nEntries
  [in] Specifies the number of entries in the logical palette to be retrieved.

• lppe
  [out] Long pointer to an array of PALETTEENTRY structures to receive the palette entries.

  The array must contain at least as many structures as specified by the nEntries parameter.

Return Value

If the handle of the logical color palette is a valid pointer — not NULL — the number of entries retrieved from the logical palette indicates success.

If the handle of the logical color palette is NULL, the number of entries in the specified palette indicates success. Zero indicates failure.

To get extended error information, call GetLastError.

Remarks

An application can determine whether a device supports palette operations by calling the GetDeviceCaps function and specifying the RASTERCAPS constant.

If the nEntries parameter specifies more entries than exist in the palette, the remaining members of the PALETTEENTRY structure are not altered.

Requirements

See Also

Reference

GetNearestPaletteIndex
GetSystemPaletteEntries
PALETTEENTRY
GDI Functions