GetSystemPaletteEntries

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.

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

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 Values

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

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Wingdi.h		Mgpal.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.