Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 PALETTEENTRYstructures to receive the palette entries.

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

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

GetSystemPaletteEntriesfails if the device associated with hdcdoes not have a settable palette. Call the GetDeviceCapsfunction, specifying the RASTERCAPS constant, to determine if the device has a settable palette before calling GetSystemPaletteEntries.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also