Share via

Gdi::GetNearestPaletteIndex_I

  • Article

This method retrieves the index for the entry in the specified logical palette that most closely matches a specified color value.

static WINGDIAPI unsigned int WINAPI GetNearestPaletteIndex_I(
  HPALETTE hpal, 
  COLORREF crColor
);

Parameters

  • hpal
    [in] Handle to a logical color palette.
  • crColor
    [in] COLORREF value that specifies a color to be matched.

Return Values

The index of an entry in a logical palette indicates success. CLR_INVALID indicates failure. To get extended error information, call GetLastError.

Remarks

This method is an internal version of the GetNearestPaletteIndex function.

An application can determine whether a device supports palette operations by calling the Gdi::GetDeviceCaps_I method and specifying the RASTERCAPS constant.

If the given logical palette contains entries with the PC_EXPLICIT flag set, the return value is undefined.

Requirements

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

See Also

GetNearestPaletteIndex | Gdi::GetDeviceCaps_I | Gdi::GetPaletteEntries_I | Gdi::GetSystemPaletteEntries_I

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.