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.
A version of this page is also available for
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 GetDeviceCapsfunction and specifying the RASTERCAPS constant.

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

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also