Share via

GetNearestPaletteIndex

  • Article

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

UINT GetNearestPaletteIndex( 
  HPALETTE hpal, 
  COLORREF crColor
);

Parameters

  • hpal
    [in] Handle to a logical color palette.
  • crColor
    [in] 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

An application can determine whether a device supports palette operations by calling the GetDeviceCaps function 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 2.0 and later.
Header: Windows.h.
Link Library: Coredll.lib.

See Also

GetDeviceCaps | GetPaletteEntries | GetSystemPaletteEntries | GDI Functions

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.