GetDIBColorTable function

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

UINT GetDIBColorTable(
  HDC     hdc,
  UINT    iStart,
  UINT    cEntries,
  RGBQUAD *prgbq
);

Parameters

hdc

A handle to a device context. A DIB section bitmap must be selected into this device context.

iStart

A zero-based color table index that specifies the first color table entry to retrieve.

cEntries

The number of color table entries to retrieve.

prgbq

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

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wingdi.h (include Windows.h)
Library Gdi32.lib
DLL Gdi32.dll

See Also

BITMAPINFOHEADER

Bitmap Functions

Bitmaps Overview

CreateDIBSection

DIBSECTION

GetObject

RGBQUAD

SetDIBColorTable