GetSystemPaletteEntries

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves a range of palette entries from the system palette associated with the specified device context.

Syntax

UINT GetSystemPaletteEntries( 
  HDC hdc, 
  UINT iStartIndex, 
  UINT nEntries, 
  LPPALETTEENTRY lppe
);

Parameters

• hdc
  [in] Handle to the device context (DC).

• iStartIndex
  [in] Index of the first entry to be retrieved from the system palette.

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

• 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.

  If this parameter is NULL, the function returns the total number of entries in the palette.

Return Value

The number of entries retrieved from the palette indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

GetSystemPaletteEntries fails if the device associated with hdc does not have a settable palette. Call the GetDeviceCaps function, specifying the RASTERCAPS constant, to determine if the device has a settable palette before calling GetSystemPaletteEntries.

Requirements

See Also

Reference

GetDeviceCaps
GetNearestPaletteIndex
PALETTEENTRY
GDI Functions