IWICBitmapSource::CopyPalette method (wincodec.h)

Retrieves the color table for indexed pixel formats.

Syntax

HRESULT CopyPalette(
  [in] IWICPalette *pIPalette
);

Parameters

[in] pIPalette

Type: IWICPalette*

An IWICPalette. A palette can be created using the CreatePalette method.

Return value

Type: HRESULT

Returns one of the following values.

Return code	Description
WINCODEC_ERR_PALETTEUNAVAILABLE	The palette was unavailable.
S_OK	The palette was successfully copied.

Remarks

If the IWICBitmapSource is an IWICBitmapFrameDecode, the function may return the image's global palette if a frame-level palette is not available. The global palette may also be retrieved using the CopyPalette method.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps | UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps | UWP apps]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll