GetNearestPaletteIndex

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

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Wingdi.h   Mgpal.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetDeviceCaps, GetLastError, GetPaletteEntries, GetSystemPaletteEntries

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.