SetDIBColorTable function (wingdi.h)

Article
02/22/2024

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

Syntax

UINT SetDIBColorTable(
  [in] HDC           hdc,
  [in] UINT          iStart,
  [in] UINT          cEntries,
  [in] const RGBQUAD *prgbq
);

Parameters

[in] hdc

A device context. A DIB must be selected into this device context.

[in] iStart

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

[in] cEntries

The number of color table entries to set.

[in] prgbq

A pointer to an array of RGBQUAD structures containing new color information for the DIB's color table.

Return value

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

If the function fails, the return value is zero.

Remarks

This function should be called to set the color table for DIBs that use 1, 4, or 8 bpp. The BitCount member of a bitmap's associated bitmap information header structure.

BITMAPINFOHEADER structure specifies the number of bits-per-pixel. Device-independent bitmaps with a biBitCount value greater than 8 do not have a color table.

The bV5BitCount member of a bitmap's associated BITMAPV5HEADER structure specifies the number of bits-per-pixel. Device-independent bitmaps with a bV5BitCount value greater than 8 do not have a color table.

ICM: No color management is performed.

Requirements

Requirement	Value
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