Image::GetPalette method

The Image::GetPalette method gets the ColorPalette of this Image object.

Syntax

Status GetPalette(
  OUT ColorPalette *palette,
  IN INT           size
);

Parameters

palette

Type: ColorPalette*

Pointer to a ColorPalette structure that receives the palette.

size

Type: INT

Integer that specifies the size, in bytes, of the palette. Call the Image::GetPaletteSize method to determine the size.

Return Value

Type: Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

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

See Also

Bitmap

Color

ColorPalette

Image

Image::GetPaletteSize

Image::SetPalette

Images, Bitmaps, and Metafiles

Using Images, Bitmaps, and Metafiles