Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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(
  _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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Bitmaps Overview
Bitmap Functions
BITMAPINFOHEADER
CreateDIBSection
DIBSECTION
GetObject
RGBQUAD
SetDIBColorTable

 

 

Show:
© 2016 Microsoft