IBitmapImage::GetPalette
A version of this page is also available for
4/8/2010
This method provides a color palette associated with a bitmap image object.
Syntax
HRESULT GetPalette(
ColorPalette** palette
);
Parameters
- palette
[out] A pointer to a pointer to a ColorPalette structure containing the color palette data for the bitmap image.
Return Value
If successful, this method returns S_OK.
If it fails, this method should return one of the following error values:
- IMGERR_NOPALETTE
- IMGERR_OBJECTBUSY
- E_OUTOFMEMORY
For more information, see Error Codes for the Imaging API.
Remarks
The color palette returned by this method is a copy of the palette in the bitmap.
Your application is responsible for freeing the memory for the palette by calling CoTaskMemFree.
Requirements
Header | imaging.h |
Library | Imaging.lib |
Windows Embedded CE | Windows CE 5.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |