Share via

Gdi::GetSystemPaletteEntries_I

  • Article

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

static WINGDIAPI unsigned int WINAPI GetSystemPaletteEntries_I(
  HDC hdc,
  unsigned int iStartIndex,
  unsigned int nEntries,
  PALETTEENTRY* lppe
);

Parameters

  • hdc
    [in] Handle to the device context (DC).
  • iStartIndex
    [in] Unsigned integer that specifies the index of the first entry to be retrieved from the system palette.
  • nEntries
    [in] Unsigned integer that 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 Values

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

Remarks

This method is an internal version of the GetSystemPaletteEntries function.

Gdi::GetSystemPaletteEntries_I fails if the device associated with hdc does not have a settable palette. Call the Gdi::GetDeviceCaps_I method, specifying the RASTERCAPS constant, to determine if the device has a settable palette before calling Gdi::GetSystemPaletteEntries_I.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

GetSystemPaletteEntries | Gdi::GetDeviceCaps_I | Gdi::GetNearestPaletteIndex_I | PALETTEENTRY

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.