This topic has not yet been rated - Rate this topic

GetDIBColorTable function

Applies to: desktop apps only

The GetDIBColorTable function retrieves RGB (red, green, blue) color values from a range of entries in the color table of the DIB section bitmap that is currently selected into a specified device context.

Syntax

Copy

UINT GetDIBColorTable(
  __in   HDC hdc,
  __in   UINT uStartIndex,
  __in   UINT cEntries,
  __out  RGBQUAD *pColors
);

Parameters

hdc [in]: A handle to a device context. A DIB section bitmap must be selected into this device context.
uStartIndex [in]: A zero-based color table index that specifies the first color table entry to retrieve.
cEntries [in]: The number of color table entries to retrieve.
pColors [out]: A pointer to a buffer that receives an array of RGBQUAD data structures containing color information from the DIB color table. The buffer must be large enough to contain as many RGBQUAD data structures as the value of cEntries.

Return value

If the function succeeds, the return value is the number of color table entries that the function retrieves.

If the function fails, the return value is zero.

Remarks

The GetDIBColorTable function should be called to retrieve the color table for DIB section bitmaps that use 1, 4, or 8 bpp. The biBitCount member of a bitmap associated BITMAPINFOHEADER structure specifies the number of bits-per-pixel. DIB section bitmaps with a biBitCount value greater than eight do not have a color table, but they do have associated color masks. Call the GetObject function to retrieve those color masks.

Requirements