IWICBitmapSource::CopyPalette method

Retrieves the color table for indexed pixel formats.

Syntax


HRESULT CopyPalette(
  [in]  IWICPalette *pIPalette
);

Parameters

pIPalette [in]

Type: IWICPalette*

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

Return value

Type: HRESULT

Returns one of the following values.

Return codeDescription
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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft