GetNearestPaletteIndex

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

UINT GetNearestPaletteIndex( 
  HPALETTE hpal, 
  COLORREF crColor
);

Parameters

• hpal
  [in] Handle to a logical color palette.

• crColor
  [in] Specifies a color to be matched.

Return Value

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

See Also

Reference

GetDeviceCaps
GetPaletteEntries
GetSystemPaletteEntries
GDI Functions