IWICBitmapFrameDecode::GetColorContexts method (wincodec.h)

Article
02/22/2024

Retrieves the IWICColorContext associated with the image frame.

Syntax

HRESULT GetColorContexts(
  [in]      UINT             cCount,
  [in, out] IWICColorContext **ppIColorContexts,
  [out]     UINT             *pcActualCount
);

Parameters

[in] cCount

Type: UINT

The number of color contexts to retrieve.

This value must be the size of, or smaller than, the size available to ppIColorContexts.

[in, out] ppIColorContexts

Type: IWICColorContext**

A pointer that receives a pointer to the IWICColorContext objects.

[out] pcActualCount

Type: UINT*

A pointer that receives the number of color contexts contained in the image frame.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If NULL is passed for ppIColorContexts, and 0 is passed for cCount, this method will return the total number of color contexts in the image in pcActualCount.

The ppIColorContexts array must be filled with valid data: each IWICColorContext* in the array must have been created using IWICImagingFactory::CreateColorContext.

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

Share via